使用说明
推链MCP服务器
统一模型上下文协议（MCP）服务器，为人工智能助手提供对推链文档和SDK的全面访问(@pushchain/core, @pushchain/ui-kit).
这是什么？
这个统一的MCP服务器使AI助手（如Claude）能够在一个简化的界面中访问和查询Push Chain的文档和SDK。它结合了：
- 文档访问：从GitHub浏览、搜索和检索Push Chain文档
- SDK分析：来自的查询函数、类、类型和代码示例
@pushchain/core和@pushchain/ui-kit
使用此服务器，您的AI助手可以帮助您：
- 立即查找相关文档
- 了解SDK API及其使用方法
- 获取TypeScript类型定义
- 发现代码示例和最佳实践
- 通过一个统一的界面访问文档和SDK
目录
特性
- 统一接口：结合文档和SDK访问的单服务器
- 文档访问：浏览并搜索所有Push Chain
.mdxGitHub上的文档 - SDK分析：查询函数、类、类型和接口
@pushchain/core和@pushchain/ui-kit - 代码示例：从文档和SDK中查找真实的使用示例和实现模式
- 类型定义：获取完整的TypeScript类型信息
- 自动更新：自动保持GitHub上的SDK数据新鲜
- 13强大的工具：一台服务器上有4个文档工具+9个SDK工具
快速开始
# 1. Clone the repository
git clone https://github.com/kshitij-hash/push-chain-mcp-server.git
cd push-chain-mcp-server
# 2. Run the setup script
chmod +x setup.sh
./setup.sh
# 3. Follow the IDE-specific instructions in SETUP.md
设置
有关IDE的详细设置说明，请参阅 设置.md
设置指南包括：
- ✅ 先决条件和安装步骤
- ✅ Claude Code、Cursor和Windsurf的IDE特定配置
- ✅ GitHub令牌配置（可选）
- ✅ 验证步骤
- ✅ 示例查询开始
- ✅ 全面的故障排除指南
快速链接：
可用工具
统一服务器提供 13个强大的工具:
- 4文档工具：列出、搜索、阅读文档和提取代码片段
- 9个SDK工具：查询API、搜索代码、获取类型、查找示例等
所有工具都可以通过单个服务器连接访问！ 看 设置.md 了解完整的工具描述。
查询示例
配置后，尝试以下查询以开始：
文档：
"List all Push Chain tutorials"
"Show me the wallet setup guide"
"Search documentation for transaction examples"
SDK：
"What methods does PushClient have?"
"Show me the UniversalAccount type definition"
"List all React hooks in ui-kit"
组合：
"I want to build a wallet - show me relevant docs and SDK APIs"
"How do I implement transaction signing? Show types, functions, and examples"
有关50多个综合测试查询，请参阅 TEST-QUIRIES.md
有关详细的示例查询和入门指南，请参阅 设置.md
发展
# Start server
npm start
# Update data
npm run update:sdk # Check for SDK updates
npm run update:docs # Fetch latest documentation
配置： 创建一个 .env GitHub令牌和自动更新设置的文件。看 设置.md 了解详情。
支持
- 安装指南: 设置.md -所有IDE的详细设置说明
- 测试查询: TEST-QUIRIES.md -50+综合测试查询
- 文档：有关项目概述，请参阅此README
- 问题: GitHub问题
致谢
- 内置 模型上下文协议（MCP）
- 由...驱动 @模型上下文协议/sdk
- 专为与Claude、Cursor、Windsurf和其他MCP兼容的AI助手一起使用而设计
由以下材料制成❤️ 适用于Push Chain开发人员
