VibesRails MCP 服务器

使用说明（Markdown 格式）

• 项目简介

  • VibesRails 的 MCP 服务器实现为面向 LLM 客户端的后端服务，以 MCP（模型上下文协议）标准提供上下文资源、工具和提示模板的访问与渲染能力，便于在 AI 辅助的编程场景中统一获取上下文信息和外部功能。

• 主要功能点

  • 资源托管与数据访问：以标准化方式暴露并管理后端资源，方便 LLM 客户端读取与查询。
  • 工具注册与执行：注册一组工具，LLM 客户端可通过 MCP 调用外部功能，获得结果并渲染到对话中。
  • 提示模板定义与渲染：提供可定制的 Prompt 模板，支持多种交互模式与上下文渲染。
  • JSON-RPC 通信：通过 JSON-RPC 接收客户端请求，返回响应或通知，具备会话管理与能力声明能力。
  • 多传输协议扩展：默认以 stdio 通信，未来可扩展为 SSE、WebSocket 等传输方式，提升集成灵活性。
  • 服务器生命周期与 migrations：启动时执行数据库迁移，记录服务器能力与运行信息。

• 安装步骤

  • 通过包管理工具安装（示例性依赖）：
    • 支持 MCP 的安装分支或额外依赖包安装 vibesrails[mcp]。
  • 如果从源码构建，请执行开发环境安装步骤以确保 MCP 相关依赖可用。

• 服务器配置（MCP 客户端所需的最小配置信息）

  • 说明：下面的配置用于 MCP 客户端在启动时连接到 MCP 服务器，包含服务器名称、启动命令以及参数。注意，MCP 客户端并不需要该部分作为必须的执行代码，仅用于描述连接信息。
  • 配置示例（JSON，导出后由客户端用于连接）： { "server_name": "vibesrails", "command": "vibesrails-mcp", "args": [] }
  • 说明：
    • server_name：MCP 客户端在本地配置中使用的服务器标识，与 MCP.json 配置中的名称保持一致。
    • command：启动 MCP 服务器所使用的可执行命令（本仓库中对应的入口脚本应提供 vibesrails-mcp）。
    • args：启动命令的参数数组。当前实现默认不强制额外参数，可根据需要追加传输配置或工作目录等参数。

• 基本使用

  • 启动方式：在具备 MCP 客户端的环境中，通过 vibesrails-mcp 启动 MCP 服务器（默认 stdio 传输）。
  • 客户端交互：客户端通过 MCP 协议向服务器发起读取资源、调用工具、获取 Prompt 等请求，服务器返回标准化的 JSON-RPC 响应。
  • 监控与扩展：服务器具备会话管理、能力声明，以及对外暴露的工具集合与资源集合，便于后续扩展和多客户端并发。