检查MCP服务器模块
一个强大的模型上下文协议(MCP)服务器,用于管理内部文档和从web获取官方图书馆文档。
  ](https://nodejs.org/) 
🎥 演示
https://github.com/user-attachments/assets/aec8d362-4ac3-477f-84db-fc304cd7e927
观看CHECK-MODULE的操作:使用Claude Desktop获取文档、搜索内部文档和管理自定义文档。
🎯 特性
- 📚 内部文件管理 -存储、搜索和管理您的自定义文档
- 🌐 Web文档获取 -自动从13+个流行库中获取官方文档
- 🔍 智能搜索 -基于相关性的搜索,具有类别和标签过滤功能
- 📝 Markdown支持 -文档的完整Markdown格式
- 🔧 MCP工具 -通过模型上下文协议公开的6个强大工具
- 📦 资源 -基于URI的文档访问(
doc://internal/*)
📦 安装
# Clone the repository
git clone https://github.com/muhammedehab35/CHECK-MODULE-MCP.git
cd CHECK-MODULE-MCP
# Install dependencies
npm install
# Build the project
npm run build⚙️ 配置
添加到您的Claude Desktop配置文件(claude_desktop_config.json):
窗户: %APPDATA%\Claude\claude_desktop_config.json macOS/Linux: ~/.claude/claude_desktop_config.json
{
"mcpServers": {
"CHECK-MODULE": {
"command": "node",
"args": [
"/absolute/path/to/CHECK-MODULE-MCP/dist/index.js"
]
}
}
}然后完全重新启动Claude Desktop。
🚀 用法
内部文档工具
search-docs -搜索您的内部文档
Search for "authentication" in the documentationget-doc -按ID获取完整文档
Show me the Authentication API guidelist-categories -列出所有文档类别
What documentation categories are available?add-doc -添加或更新文档
Add documentation about Redis caching with ID "redis-cache"Web文档获取
fetch-library-docs -从网上获取官方文件
Use CHECK-MODULE to fetch LangGraph documentation about creating agentslist-available-libraries -显示支持的库
What libraries can CHECK-MODULE fetch documentation for?📚 支持的库
CHECK-MODULE可以自动获取以下文档:
- AI/ML: LangGraph、LangChain、PyTorch、TensorFlow、CrewAI
- Web框架: React、Next.js、Vue、Express、FastAPI、Django
- 数据科学: 熊猫,NumPy
🛠️ 可用工具
| 工具 | 说明 |
|---|---|
search-docs | 使用过滤器搜索内部文档 |
get-doc | 按ID检索完整文档 |
list-categories | 列出所有文档类别 |
add-doc | 添加或更新文档 |
fetch-library-docs | 从网上获取官方文档 |
list-available-libraries | 显示支持的库 |
🏗️ 项目结构
CHECK-MODULE-MCP/
├── src/
│ ├── index.ts # Main MCP server
│ ├── docStore.ts # Documentation storage
│ ├── webFetcher.ts # Web documentation fetcher
│ └── types.ts # TypeScript type definitions
├── dist/ # Compiled JavaScript (generated)
├── package.json # Project configuration
├── tsconfig.json # TypeScript configuration
└── README.md # This file🔧 发展
# Install dependencies
npm install
# Build
npm run build
# Watch mode (auto-rebuild)
npm run watch
# Run manually (for testing)
npm start📖 例子
示例1:搜索内部文档
User: Search for "deployment" in DevOps category
Claude: [Uses search-docs tool]
Found 1 result: Deployment Guide with Docker/Kubernetes instructions示例2:获取Web文档
User: How do I create an agent in LangGraph?
Claude: [Uses fetch-library-docs tool]
Fetches from https://langchain-ai.github.io/langgraph/
Returns: Step-by-step guide with code examples示例3:添加自定义文档
User: Add docs about our Redis caching strategy
Claude: [Uses add-doc tool]
Documentation stored with ID "redis-cache"🎨 定制
添加更多库
编辑 src/webFetcher.ts 要添加自定义文档源,请执行以下操作:
const DOC_SOURCES: Record = {
'your-library': 'https://docs.your-library.com/',
// ... existing libraries
};然后重建: npm run build
预加载文件
编辑 src/docStore.ts 在 initializeSampleDocs() 添加初始文档的方法。
🐛 故障排除
服务器未启动
# Test the build
npm run build
# Run directly
node dist/index.js
# Should output: "CHECK-MODULE MCP Server running on stdio"克劳德没有看到工具
- 检查路径是否正确
claude_desktop_config.json是绝对的 - 完全重新启动克劳德桌面
- 检查开发人员控制台(
Ctrl+Shift+I)对于错误
Web获取不起作用
- 确保您有互联网连接
- 检查库是否在支持列表中
- 库名称必须完全匹配(不区分大小写)
📝 预加载文档
服务器附带了3个示例文档:
- 身份验证API (
api-auth)-JWT身份验证指南 - 数据库模式 (
db-schema)-PostgreSQL模式参考 - 部署指导 (
deploy-guide)-Docker/Kubernetes部署
🔮 路线图
- \[\]添加更多库文档源
- \[\]实现持久存储(SQLite/PPostgreSQL)
- \[\]添加版本历史跟踪
- \[\]支持自定义身份验证
- \[\]用于外部管理的REST API
- \[\]从Markdown文件导入
- \[\]将文档导出为各种格式
🤝 贡献
欢迎投稿!请随时提交拉取请求。
- 分叉项目
- 创建功能分支(
git checkout -b feature/AmazingFeature) - 提交您的更改(
git commit -m 'Add some AmazingFeature') - 推到分支(
git push origin feature/AmazingFeature) - 打开拉取请求
📄 许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
🙏 致谢
- 建于 @模型上下文协议/sdk
- 灵感来自 背景7
- 用途 佐德 用于模式验证
📞 支持
- 问题:
- 文档: MCP文件
______________________________________________________________________
由...制作❤️ 使用TypeScript和MCP
