README
🚀 Poke - MCP
Poke - MCP 是一个基于模型上下文协议(MCP)构建的服务,它通过统一接口为用户提供 Pokémon 信息。该服务连接 PokeAPI 获取 Pokémon 数据,并借助 MCP 工具为 Claude 桌面应用、Continue、Cline 等兼容客户端提供数据支持,让用户能更便捷地查询 Pokémon 相关信息。
🚀 快速开始
Poke - MCP 借助模型上下文协议(MCP),实现了 AI 应用程序与外部数据源的标准化交互。以下是其工作流程:
- 连接到 PokeAPI 获取 Pokémon 数据。
- 通过 MCP 接口暴露多个工具。
- 处理 MCP 客户端请求。
- 返回格式化 Pokémon 信息。
✨ 主要特性
- 通过名称查询特定 Pokémon 的详细信息。
- 随机获取 Pokémon 信息。
- 根据地区查找随机 Pokémon(如卡洛斯、丰缘、神奥等)。
- 按类型筛选随机 Pokémon(如火、水、电等)。
- 支持自然语言查询 Pokémon 相关问题。
📦 安装指南
使用 Smithery 快速安装
通过 [Smithery](https://smithery.ai/server/@NaveenBandarage/poke - mcp) 可自动为 Claude 桌面应用安装 Poke - MCP:
npx -y @smithery/cli install @NaveenBandarage/poke-mcp --client claude
手动安装
# 克隆仓库
git clone https://github.com/yourusername/poke-mcp.git
cd poke-mcp
# 安装依赖项
npm install
# 构建项目
npm run build
💻 使用示例
在 Claude 桌面应用中使用
- 下载并安装 Claude 桌面应用。
- 打开 Claude 设置界面。
- 进入开发者设置,编辑配置文件。
- 添加以下配置:
{
"mcpServers": {
"pokedex": {
"command": "path/to/poke-mcp/build/index.js"
}
}
}
- 重启 Claude 桌面应用。
- 现在您应该可以看到 Pokémon 工具已集成到 Claude。
示例查询
连接到 MCP 客户端后,可以执行以下命令:
- "告诉我关于皮卡丘的信息"
- "给我一个随机的精灵"
- "展示一个来自卡洛斯地区的随机精灵"
- "有什么水属性的精灵?"
项目结构
src/index.ts:主服务实现。src/types.ts:TypeScript 类型定义文件。package.json:项目依赖及脚本信息。tsconfig.json:TypeScript 配置文件。
扩展新功能
要添加新工具或增强现有功能:
- 定义新的辅助函数以获取和格式化数据。
- 使用
server.tool()方法注册新工具。 - 实现具体的业务逻辑。
🔧 技术细节
服务采用以下技术构建:
- TypeScript
- MCP TypeScript SDK (@modelcontextprotocol/sdk)
- Zod 进行输入验证
- 标准 I/O 传输协议实现 MCP 通信
📄 许可证
本项目遵循 MIT 许可证协议。
Scan to join WeChat group