使用说明

项目简介

Pokémcp 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型（LLM）客户端提供宝可梦 (Pokémon) 相关的信息。它通过连接到 PokeAPI 获取数据，并将这些数据以 MCP 工具的形式暴露出来，供兼容 MCP 协议的客户端（如 Claude Desktop App, Continue, Cline 等）使用。

主要功能点

宝可梦信息查询: 获取指定宝可梦的详细信息（通过名称）。
随机宝可梦发现: 获取随机宝可梦的信息。
地区限定宝可梦: 获取特定地区（如关都、城都等）的随机宝可梦。
类型限定宝可梦: 获取特定类型（如火、水、电等）的随机宝可梦。
自然语言查询: 支持使用自然语言查询宝可梦信息。

安装步骤

克隆仓库: 打开终端，执行命令 'git clone https://github.com/NaveenBandarage/poke-mcp.git' 克隆 Pokémcp 仓库到本地。
进入目录: 执行 'cd poke-mcp' 进入项目目录。
安装依赖: 执行 'npm install' 安装项目所需的依赖包。
构建项目: 执行 'npm run build' 构建项目，生成可执行的服务器代码。

服务器配置

对于 MCP 客户端（例如 Claude Desktop App），您需要配置 Pokémcp 服务器的启动命令。在客户端的配置文件中，添加如下 JSON 配置：

{
  "mcpServers": {
    "pokedex": {
      "command": "<项目路径>/poke-mcp/build/index.js"
    }
  }
}

配置说明:

'server name': 'pokedex' (服务器名称，客户端用以识别和调用，可自定义)
'command': '<项目路径>/poke-mcp/build/index.js' (Pokémcp 服务器的启动命令。请将 '<项目路径>' 替换为实际的 Pokémcp 项目在您电脑上的绝对路径)

注意: 请确保将 '<项目路径>/poke-mcp/build/index.js' 替换为 'index.js' 文件在您本地文件系统中的 绝对路径。例如，如果您的项目放在用户目录下的 'Documents/poke-mcp' 文件夹中，则命令可能类似于 '/Users/yourusername/Documents/poke-mcp/build/index.js' (macOS/Linux) 或 'C:\Users\YourUsername\Documents\poke-mcp\build\index.js' (Windows)。

基本使用方法

配置完成后，在 MCP 客户端中，您可以像与 LLM 正常对话一样提问，例如：

"Tell me about Pikachu" (告诉我关于皮卡丘的信息)
"Give me a random Pokémon" (给我一个随机宝可梦)
"Show me a random Pokémon from Kanto" (展示一个关都地区的随机宝可梦)
"What's a random Water Pokémon?" (有什么水属性的随机宝可梦？)

客户端会将这些问题通过 Pokémcp 服务器转化为对 PokeAPI 的查询，并将结果返回给您。

关键词