🚀 神岛数据统计 MCP 服务器
本服务器基于 Model Context Protocol (MCP) 构建，可提供对神岛平台用户数据、地图信息和统计数据的访问，为开发者提供便捷的数据获取途径。
🚀 快速开始
基于 Model Context Protocol (MCP) 的服务器，提供对神岛平台用户数据、地图信息和统计数据的访问。你可以通过公开 API 访问基础数据，也能使用认证 API 获取高级数据。
✨ 主要特性
- 公开 API：无需认证即可访问基础数据，如用户资料、地图详情、评论列表等。
- 认证 API：需使用 Token 访问高级数据，例如用户评论、各类统计数据。
- 地图分析：提供全面的地图玩家数据、留存率、行为分析等。
- 类型安全：具备完整的 TypeScript 类型定义，可提供代码提示和错误检查。
- 模块化设计：代码结构清晰，便于维护和扩展。
- 标准接口：基于 MCP 协议，提供标准化的工具接口。
- 易于集成：支持多平台客户端集成，涵盖浏览器、CLI 等。
📦 安装指南
文档未提供安装步骤，暂不展示。
💻 使用示例
基础用法
// 获取用户资料
const userProfile = await getUserProfile(userId);
高级用法
// 获取地图统计数据
const mapStats = await getMapStats(mapId, 'daily');
📚 详细文档
可用工具
公开 API (无需认证)
| 工具名称 | 描述 | 参数 |
|---|---|---|
getUserProfile |
获取用户个人资料 | userId |
getMapInfo |
获取地图详情信息 | mapId |
getMapCommentList |
获取地图评论列表 | contentId, limit, offset, orderBy, contentType |
getMapReleaseInfo |
获取地图发布信息 | contentId, limit, offset |
getMapList |
通过模糊关键字获取地图列表 | keyword, limit, offset ,orderBy |
需要认证的 API (需要 Token)
| 工具名称 | 描述 | 参数 |
|---|---|---|
getUserComments |
获取用户评论 | userId, limit, offset |
.getMapStats |
获取地图统计数据 | mapId, statType |
getPlaySession |
获取玩家游戏会话信息 | sessionId |
updateMapMetadata |
更新地图元数据 | mapId, metadata |
项目结构
├── index.ts # 主入口文件
├── src/ # 源代码目录
│ ├── types/ # 类型定义
│ │ └── index.ts # 共享类型定义
│ ├── utils/ # 工具函数
│ │ └── api.ts # API 请求工具
│ └── tools/ # MCP 工具实现
│ ├── publicTools.ts # 公开 API 工具
│ └── authTools.ts # 需要认证的 API 工具
├── package.json # 项目配置和依赖
├── tsconfig.json # TypeScript 配置
└── README.md # 项目文档
添加新的 API 端点
要添加新的 API 端点，请按照以下步骤操作：
- 在
src/types/index.ts中添加新的类型定义（如需要）。 - 对于公开 API，在
src/tools/publicTools.ts中添加新的工具定义。 - 对于需要认证的 API，在
src/tools/authTools.ts中添加新的工具定义。
🔧 技术细节
本项目使用的技术栈如下：
- TypeScript
- 模型上下文协议 (MCP)
- Zod (类型验证)
- Axios (HTTP 请求)
📄 许可证
本项目采用 MIT 许可证。