README
🚀 宝可梦MCP服务器
这是一个模型上下文协议(MCP)服务器,可通过PokeAPI访问宝可梦数据。该服务器允许Claude和其他支持MCP的客户端获取宝可梦的详细信息,包括属性、类型、技能和进化链等。
🚀 快速开始
宝可梦MCP服务器可帮助你便捷地获取宝可梦的各类详细信息。以下是使用该服务器的步骤:
前提条件
- Node.js 18 或更高版本
- npm 或 yarn 包管理器
安装步骤
- 克隆此仓库:
git clone <your-repository-url>
cd pokemon-mcp
- 安装依赖项:
npm install
- 构建项目:
npm run build
运行模式
开发模式
若要在开发模式下运行服务器,可使用以下命令:
npm run dev
生产模式
构建完成后,你可以运行编译后的服务器:
node build/index.js
✨ 主要特性
- 宝可梦总览:获取任何宝可梦的全面信息,包括名称、类型、基础属性和描述。
- 技能详情:获取宝可梦技能的详细信息,包括威力、PP值、类型和伤害类别。
- 进化链:检索任何宝可梦的完整进化链。
💻 使用示例
可用工具
1. 获取宝可梦总览
- 工具名称:
get_pokemon_overviews - 描述:获取多个宝可梦的总览信息
- 参数:
pokemonNames:宝可梦名称数组(例如,['pikachu', 'charizard'])
- 返回值:每个宝可梦的名称、类型、基础属性和描述
2. 获取技能详情
- 工具名称:
get_move_detail - 描述:获取特定宝可梦技能的详细信息
- 参数:
move:技能名称(例如,'hyper beam', 'thunder bolt')
- 返回值:技能名称、威力、PP值、类型、类别和伤害类别
3. 获取进化链
- 工具名称:
get_evolution_chain - 描述:获取宝可梦的完整进化链
- 参数:
pokemonName:宝可梦名称(例如,'bulbasaur')
- 返回值:从基础形态到最终进化形态的完整进化链
与Claude桌面版连接
若要将此MCP服务器与Claude桌面版一起使用,你需要在Claude桌面版设置中进行配置。
配置步骤
- 打开Claude桌面版。
- 导航至“设置”→“开发者”→“编辑配置”。
- 将以下配置添加到你的
claude_desktop_config.json文件中:
{
"mcpServers": {
"pokemon": {
"command": "node",
"args": ["/path/to/your/pokemon-mcp/build/index.js"],
"env": {}
}
}
}
重要提示:请将/path/to/your/pokemon-mcp/替换为你项目目录的实际绝对路径。
替代方法:使用npx(如果已发布)
如果你已将此项目发布为npm包,可以使用以下配置:
{
"mcpServers": {
"pokemon": {
"command": "npx",
"args": ["pokemon-mcp"],
"env": {}
}
}
}
验证连接
- 更新配置后重启Claude桌面版。
- 在Claude界面中查找🔌图标,该图标表示MCP服务器已连接。
- 你应该会看到“pokemon”作为可用的MCP服务器列出。
- 通过向Claude询问宝可梦信息来测试连接。
与Claude的使用示例
连接成功后,你可以向Claude提出以下问题:
- “你能获取皮卡丘和喷火龙的信息吗?”
- “技能十万伏特的详情是什么?”
- “给我展示杰尼龟的进化链”
- “比较妙蛙种子、小火龙和杰尼龟的属性”
📚 详细文档
API数据源
此服务器从PokeAPI获取数据,这是一个免费且开放的宝可梦API。服务器包含缓存机制,以提高性能并减少API调用次数。具体而言,本项目使用了pokedex-promise-v2。
项目结构
pokemon-mcp/
├── src/
│ ├── index.ts # 主要的MCP服务器实现
│ └── pokemonHelper.ts # 宝可梦API辅助函数
├── build/ # 编译后的JavaScript输出
├── package.json
├── tsconfig.json
└── README.md
开发脚本
npm run dev- 在开发模式下运行服务器,并支持热重载npm run build- 将TypeScript编译为JavaScript
依赖项
@modelcontextprotocol/sdk- 用于构建MCP服务器的MCP SDKpokedex-promise-v2- 基于Promise的PokeAPI包装器zod- 模式验证库
故障排除
服务器无法连接
- 确保Claude桌面版配置中的路径正确且为绝对路径。
- 验证构建目录是否存在并包含编译后的JavaScript文件。
- 检查Node.js是否已安装并可从命令行访问。
未找到宝可梦
- 确保宝可梦名称拼写正确(不区分大小写)。
- 使用官方宝可梦名称(例如,使用“nidoran-f”表示雌性尼多兰)。
未找到技能
- 技能名称应使用连字符代替空格(例如,使用“hyper-beam”而不是“hyper beam”)。
- 服务器会自动将空格转换为连字符,但建议使用正确的格式。
📄 许可证
本项目采用ISC许可证。
贡献
欢迎提交问题和改进请求!
Scan to join WeChat group