宝石包自述MCP服务器
 ](https://www.npmjs.com/package/gem-package-readme-mcp-server) ](https://www.npmjs.com/package/gem-package-readme-mcp-server) ](https://github.com/elchika-inc/gem-package-readme-mcp-server)
MCP(模型上下文协议)服务器,使AI助手能够从RubyGems.org获取有关Ruby gems的全面信息,包括README内容、gem元数据和搜索功能。
特性
- 包README检索:从RubyGems.org上托管的RubyGems中获取带有使用示例的格式化README内容
- 包裹信息:获取全面的gem元数据,包括依赖关系、版本、作者信息和下载统计信息
- 程序包搜索:搜索RubyGems注册表,按流行度、类别和作者进行筛选
- 智能缓存:智能缓存系统,可优化API的使用并提高响应时间
- GitHub集成:与GitHub API无缝集成,增强了从宝石存储库获取README的能力
- 错误处理:具有自动重试逻辑和回退策略的强大错误处理
MCP客户端配置
将此服务器添加到MCP客户端配置中:
{
"mcpServers": {
"gem-package-readme": {
"command": "npx",
"args": ["gem-package-readme-mcp-server"],
"env": {
"GITHUB_TOKEN": "your_github_token_here"
}
}
}
}备注:The GITHUB_TOKEN 是可选的,但建议在从GitHub获取README内容时使用更高的API速率限制。可用工具
get_package_readme
检索Ruby gems的全面README内容和使用示例。
参数:
{
"package_name": "rails",
"version": "latest",
"include_examples": true
}package_name(字符串,必填):Ruby gem名称(例如,“rails”、“design”、“rspec”)version(字符串,可选):特定gem版本或“最新”(默认:“最新的”)include_examples(布尔值,可选):包括使用示例和代码片段(默认值:true)
退货: 格式化的README内容,包括安装说明、使用示例和API文档。
get_package_info
从RubyGems.org获取详细的gem元数据、依赖关系和作者信息。
参数:
{
"package_name": "activerecord",
"include_dependencies": true,
"include_dev_dependencies": false
}package_name(string,必填):Ruby gem名称include_dependencies(布尔值,可选):包括运行时依赖关系(默认值:true)include_dev_dependencies(布尔值,可选):包括开发依赖关系(默认值:false)
退货: Gem元数据,包括版本信息、作者详细信息、许可证、下载统计数据和依赖关系信息。
搜索包
在RubyGems注册表中搜索具有过滤功能的宝石。
参数:
{
"query": "web framework",
"limit": 20,
"author": "dhh"
}query(字符串,必填):搜索词(宝石名称、描述、关键字)limit(number,可选):返回的最大结果数(默认值:20,最大值:100)author(字符串,可选):按gem作者/维护者筛选
退货: 包含名称、描述、作者和下载统计信息的匹配宝石列表。
错误处理
服务器优雅地处理常见错误场景:
- 未找到宝石:返回带有类似gem建议的清晰错误消息
- 速率限制:实现指数回退的自动重试
- 网络超时:具有重试逻辑的可配置超时
- 无效的宝石名称:验证gem名称格式并提供指导
- RubyGems API失败:API不可用时的回退策略
许可证
麻省理工学院
