README
🚀 status_mcp
status_mcp 是一个 Ruby gem,它通过 MCP(Model Context Protocol)服务器工具,从 awesome-status 提供状态页面信息。该 gem 可与支持 MCP 的客户端集成,如 Cursor IDE、Claude Desktop 以及其他启用 MCP 的工具。本项目由 Kisko Labs 赞助。
🚀 快速开始
安装
gem install status_mcp
Cursor IDE 配置
在 Cursor IDE 中,在项目里创建或更新 .cursor/mcp.json 文件:
{
"mcpServers": {
"status": {
"command": "gem",
"args": ["exec", "status_mcp"],
"env": {
"RUBY_VERSION": "3.4.7"
}
}
}
}
注意:使用 gem exec 可确保使用正确的 Ruby 版本。
Claude Desktop 配置
在 Claude Desktop 中,编辑 MCP 配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"status": {
"command": "gem",
"args": ["exec", "status_mcp"],
"env": {
"RUBY_VERSION": "3.4.7"
}
}
}
}
注意:更新配置后,重启 Claude Desktop 以使更改生效。
手动运行 MCP 服务器
安装完成后,可立即启动 MCP 服务器:
# 使用 bundler
gem install status_mcp && bundle exec status_mcp
# 或全局安装后
status_mcp
服务器将启动,并通过 STDIN/STDOUT 使用 MCP 协议进行通信。
✨ 主要特性
- 状态页面信息:可访问来自
awesome-status的 1700 多个状态页面链接。 - MCP 服务器集成:提供即用型 MCP 服务器,具备搜索和检索状态页面详情的工具。
- 无需身份验证:所有数据都包含在 gem 中。
- 支持离线使用:安装后,数据可在本地使用。
📚 详细文档
MCP 工具
MCP 服务器提供以下工具:
- search_services - 按名称搜索服务
- 参数:
query(字符串)
- 参数:
- get_service_details - 获取特定服务的详细状态链接
- 参数:
name(字符串)
- 参数:
- list_services - 列出所有可用服务(如果数量过多,最多列出前 50 个)
- 参数:
limit(可选整数,默认值:50)
- 参数:
📦 安装指南
环境要求
- Ruby 3.1 或更高版本(不支持 Ruby 3.0 及更早版本)
💻 使用示例
开发相关命令
# 安装依赖
bundle install
# 运行测试
bundle exec rspec
# 在多个 Ruby 版本上运行测试
bundle exec appraisal install
bundle exec appraisal rspec
# 运行代码检查并修复
bundle exec standardrb --fix
🤝 贡献指南
欢迎在 GitHub(https://github.com/amkisko/status_mcp.rb )上提交 bug 报告和拉取请求。更多信息请参阅 CONTRIBUTING.md。
🔒 安全问题
如果发现安全漏洞,请负责任地报告。详细信息请参阅 SECURITY.md。
📄 许可证
该 gem 以开源形式提供,遵循 MIT 许可证。
Scan to join WeChat group