使用说明

项目简介

AiderDesk MCP Server 是 AiderDesk 桌面应用内置的 MCP 服务器组件,它基于 Model Context Protocol 标准协议,为支持 MCP 协议的 LLM 客户端(如 Claude Desktop, Cursor 等)提供与 AiderDesk 应用交互的能力。

主要功能点

  • 上下文文件管理: 允许 MCP 客户端添加、删除和获取 AiderDesk 项目的上下文文件,以及查询可添加到上下文的文件列表。
  • Prompt 运行: 支持 MCP 客户端在 AiderDesk 应用中运行 Prompt,从而利用 AiderDesk 的 AI 编码能力执行代码生成、编辑等任务。

安装步骤

AiderDesk MCP Server 是 AiderDesk 应用的内置组件,无需单独安装。只需下载并安装 AiderDesk 桌面应用 即可使用。

服务器配置

要将 MCP 客户端连接到 AiderDesk MCP Server,您需要在 MCP 客户端中配置以下信息。请注意,AiderDesk 应用需要处于运行状态,MCP 服务器才能正常工作。

以下配置信息为 JSON 格式,您需要根据您的操作系统选择相应的 'args' 参数,并将占位符替换为实际路径。

{
  "mcpServers": {
    "aider-desk": {  // 服务器名称 (server name):  用户自定义,在 MCP 客户端中唯一标识此服务器
      "command": "node", // 启动命令 (command): Node.js 运行时环境命令
      "args": [ /* 命令参数 (args): 请根据操作系统选择以下参数 */
        "/path/to/home/.config/aider-desk/mcp-server/aider-desk-mcp-server.js",  // MCP 服务器 JavaScript 文件路径
        "/path/to/project" // 你的项目目录绝对路径
      ],
      "env": {
        "AIDER_DESK_API_BASE_URL": "http://localhost:24337/api" // AiderDesk API 的基础 URL,默认即可
      }
    }
  }
}

不同操作系统的 'args' 参数示例:

  • Windows:

    "args": ["path-to-appdata/aider-desk/mcp-server/aider-desk-mcp-server.js", "/path/to/project"]
    • 'path-to-appdata': 替换为你的 AppData 目录绝对路径 (例如: 'C:\Users\YourUserName\AppData\Roaming')
  • macOS:

    "args": ["/path/to/home/Library/Application Support/aider-desk/mcp-server/aider-desk-mcp-server.js", "/path/to/project"]
    • '/path/to/home': 替换为你的用户目录绝对路径 (例如: '/Users/YourUserName')
  • Linux:

    "args": ["/path/to/home/.config/aider-desk/mcp-server/aider-desk-mcp-server.js", "/path/to/project"]
    • '/path/to/home': 替换为你的用户目录绝对路径 (例如: '/home/YourUserName')

注意:

  • '/path/to/project' 必须 替换为你的 项目目录的绝对路径
  • 请根据你的操作系统选择正确的 'args' 参数。
  • 'server name' 可以自定义,用于在 MCP 客户端中唯一标识此服务器连接。

基本使用方法

  1. 启动 AiderDesk 桌面应用程序。
  2. 在支持 MCP 协议的 LLM 客户端中,按照上述 服务器配置 填写连接信息。
  3. 连接成功后,您可以使用 MCP 客户端提供的界面或命令,调用 AiderDesk MCP Server 提供的工具,例如:
    • 使用 'add_context_file' 工具添加文件到 AiderDesk 的上下文,以便 AI 理解项目代码。
    • 使用 'run_prompt' 工具向 AiderDesk 发送 Prompt,执行代码生成或编辑任务。
    • 使用 'get_context_files' 工具获取当前 AiderDesk 上下文中的文件列表。
    • 使用 'get_addable_files' 工具获取可以添加到 AiderDesk 上下文的文件列表。

重要提示: AiderDesk MCP Server 依赖于 AiderDesk 桌面应用运行,请确保 AiderDesk 应用已启动。

信息

分类

开发者工具