使用说明

项目简介

Turbo Developer MCP Server 是 Ultra Wide Turbo Workspace (UWTW) 框架的一部分,旨在为开发者提供一个基于 Model Context Protocol (MCP) 的后端服务。它允许集成了 MCP 客户端的工具(如 Cursor IDE)访问工作空间内的工具和服务,从而增强 AI 辅助开发体验。该服务器目前提供列出可用工具和读取项目 README.md 文件的功能,未来可以扩展更多与开发工作流相关的工具。

主要功能点

  • 列出工具 (list_tools):允许 MCP 客户端查询服务器提供的所有可用工具及其详细信息,包括名称、描述、参数、示例和响应格式。
  • 获取 README 文件 (get_readme):允许 MCP 客户端读取服务器所在项目的 'README.md' 文件的内容和元数据,方便快速了解项目信息。

安装步骤

  1. 克隆仓库:首先,你需要克隆 'ultra-wide-turbo-workspace' 仓库到本地。
    git clone https://github.com/ultrawideturbodev/ultra-wide-turbo-workspace.git
    cd ultra-wide-turbo-workspace
  2. 进入 MCP 服务器目录:导航到 'developer/tools/turbo-developer-mcp' 目录。
    cd developer/tools/turbo-developer-mcp
  3. 安装依赖:使用 npm 或 yarn 安装项目依赖。
    npm install
    yarn install
  4. 构建项目:编译 TypeScript 代码。
    npm run build

服务器配置

MCP 客户端(例如 Cursor IDE)需要配置以下 JSON 格式信息以连接到 Turbo Developer MCP Server。请注意,这里的配置是用于指导 MCP 客户端如何启动和连接服务器,而不是直接在服务器端配置。

{
  "serverName": "turbo-mcp",
  "command": "node",
  "args": [
    "dist/index.js"
  ],
  "transport": "stdio"
}

配置参数说明:

  • 'serverName': 服务器名称,这里设置为 'turbo-mcp',与服务器代码中定义的名称一致。
  • 'command': 启动服务器的命令,这里使用 'node',假设你的环境中已安装 Node.js 运行时。
  • 'args': 传递给启动命令的参数,这里指向编译后的服务器入口文件 'dist/index.js'。
  • 'transport': 服务器使用的传输协议,这里设置为 'stdio',表示使用标准输入输出进行通信。

请注意: 'dist/index.js' 是在执行 'npm run build' 命令后生成的 JavaScript 文件。MCP 客户端需要能够执行 'node dist/index.js' 命令来启动服务器。 确保 MCP 客户端的配置中工作目录设置为 'developer/tools/turbo-developer-mcp'。

基本使用方法

  1. 启动 MCP 服务器:MCP 客户端会根据上述配置启动 Turbo Developer MCP Server。
  2. 客户端发送请求:客户端可以使用 MCP 协议的标准 JSON-RPC 请求与服务器通信,例如:
    • 调用 'list_tools' 工具以获取可用工具列表。
    • 调用 'get_readme' 工具以获取 'README.md' 文件内容。
  3. 服务器返回响应:服务器处理客户端请求后,会返回符合 MCP 协议的 JSON-RPC 响应。客户端根据响应内容进行后续操作。

具体工具的使用方法和参数,请参考 'list_tools' 工具返回的工具描述信息。

信息

分类

开发者工具