使用说明
项目简介
本项目是一个基于 Model Context Protocol (MCP) 的服务器,旨在为 LLM 应用提供访问宝可梦数据的能力。它通过工具的形式,允许 LLM 查询宝可梦、类型、技能和特性等信息,从而扩展 LLM 在宝可梦领域的知识和应用场景。
主要功能点
- 提供多种工具,用于查询宝可梦相关的各种信息,包括宝可梦详情、类型信息、技能信息、特性信息和宝可梦搜索。
- 基于 PokéAPI 接口,数据准确可靠。
- 使用 MCP 协议,易于与支持 MCP 的 LLM 客户端集成。
安装步骤
- 克隆仓库:
git clone https://github.com/indroneelray/pokemon-mcp-server.git - 进入项目目录:
cd pokemon-mcp-server - 安装依赖:
npm install - 构建项目:
npm run build
服务器配置(用于 MCP 客户端,如 Claude)
- 服务器名称: pokemon (可自定义)
- 启动命令 (command): node
- 启动参数 (args): [/path/to/pokemon-mcp-server/build/pokemon-server.js] (请替换为实际路径,例如 '/Users/yourname/pokemon-mcp-server/build/pokemon-server.js')
例如,在 Claude for Desktop 的配置文件中 (macOS 路径示例):
{ "mcpServers": { "pokemon": { "command": "node", "args": ["/Users/yourname/pokemon-mcp-server/build/pokemon-server.js"] } } }
注意: 请将 '/path/to/pokemon-mcp-server/build/pokemon-server.js' 替换为你实际的项目 'build/pokemon-server.js' 文件的绝对路径。Windows 路径配置请参考仓库 README。
基本使用方法
-
启动服务器:
npm start服务器将在 stdio 上运行,等待 MCP 客户端连接。
-
在 MCP 客户端中配置并连接到该服务器。 (例如,在 Claude for Desktop 中添加上面生成的服务器配置)
-
使用提供的工具。 在 LLM 客户端中,你可以通过工具名称和参数来调用服务器的功能。例如,在 Claude 中可以使用 '@pokemon:工具名称 参数' 的形式来调用,具体工具和参数如下:
-
get-pokemon: 获取宝可梦详情
- 参数: '{"nameOrId": "宝可梦名称或ID"}' (例如: '{"nameOrId": "pikachu"}' 或 '{"nameOrId": "25"}')
- 示例 Claude 调用: '@pokemon:get-pokemon nameOrId=pikachu'
-
get-type: 获取宝可梦类型信息
- 参数: '{"type": "宝可梦类型"}' (例如: '{"type": "electric"}')
- 示例 Claude 调用: '@pokemon:get-type type=electric'
-
search-pokemon: 搜索宝可梦
- 参数: '{"limit": 数量, "offset": 偏移量}' (例如: '{"limit": 5, "offset": 0}')
- 示例 Claude 调用: '@pokemon:search-pokemon limit=5 offset=0'
-
get-move: 获取宝可梦技能详情
- 参数: '{"nameOrId": "技能名称或ID"}' (例如: '{"nameOrId": "thunderbolt"}')
- 示例 Claude 调用: '@pokemon:get-move nameOrId=thunderbolt'
-
get-ability: 获取宝可梦特性详情
- 参数: '{"nameOrId": "特性名称或ID"}' (例如: '{"nameOrId": "static"}')
- 示例 Claude 调用: '@pokemon:get-ability nameOrId=static'
请参考仓库 README 和 'pokemon-server.ts' 文件了解更详细的工具参数和使用方法。
-
信息
分类
网页与API