🚀 Rails MCP 服务器
Rails MCP 服务器是一款专门用于与支持 Model Context Protocol (MCP) 的大语言模型 (LLM) 客户端集成的工具。它借助一系列预定义工具对 Rails 项目展开分析与操作，有效提升开发效率。
🚀 快速开始
Rails MCP 服务器能与支持 MCP 协议的 LLM 客户端集成，借助预定义工具对 Rails 项目进行分析和操作。下面为你介绍详细的安装、启动和使用方法。
📦 安装指南
安装依赖
- 克隆仓库：
git clone https://github.com/maquina-app/rails-mcp-server.git
cd rails-mcp-server
- 使用 Bundler 安装依赖项：
bundle install
启动服务器
- 根据需要选择模式启动：
- 标准输入输出 (STDIO) 模式（默认）：
bin/rails-mcp-server
- HTTP 模式：
bin/rails-mcp-server --mode http
💻 使用示例
基础用法
标准工具调用
所有工具均通过 MCP 协议的 tool_calls 方法执行，具体如下：
# 分析整个 Rails 项目
tool_calls :analyze_rails_project, project_path: "."
# 列出所有可用工具
tool_calls :list_tools
# 获取完整的数据库模式
tool_calls :get_schema
# 获取特定表的详细信息
tool_calls :get_schema, table_name: "users"
高级用法
环境配置分析
# 分析环境配置文件
tool_calls :analyze_environment_config
📚 详细文档
与 LLM 客户端集成
要使用支持 MCP 协议的客户端（如 Claude Desktop），请按照以下步骤操作：
- 启动 Rails MCP 服务器。
- 将客户端连接到服务器。
- 使用可用工具进行项目分析。
测试与调试
使用 MCP 检查器
MCP 检查器是一个专为测试和调试设计的开发者工具。使用步骤如下：
- 安装检查器：
npm install -g @modelcontextprotocol/inspector
- 启动检查器并连接 Rails MCP 服务器：
npx @modelcontextprotocol/inspector /path/to/rails-mcp-server
- 在浏览器中访问默认地址（
http://localhost:6274），开始交互式调用和调试。
📄 许可证
Rails MCP 服务器遵循 MIT 许可证。查看 LICENSE 文件获取详细信息。
🤝 贡献指南
欢迎贡献！请参考 CONTRIBUTING.md 获取参与方式。