Cursor DB MCP Server 使用说明

项目简介

Cursor DB MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在桥接 AI 助手和 Cursor IDE 的本地数据。通过此服务器,AI 助手可以安全、标准地访问 Cursor IDE 项目的 SQLite 数据库,从而实现更深入的项目理解和智能交互。

主要功能点

  • 项目数据访问: 提供对 Cursor IDE 项目信息的访问,包括项目列表、详细信息等。
  • 聊天记录检索: 允许 AI 助手检索特定项目的聊天记录,从而理解用户的对话上下文。
  • 编辑器配置查询: 可以查询 Cursor IDE 的编辑器配置等信息。
  • 数据库表查询: 支持自定义查询 Cursor 项目数据库中的特定表,获取更细粒度的数据。
  • 资源和工具: 通过 MCP 协议标准化的资源 (Resources) 和工具 (Tools) 暴露上述功能,方便 AI 助手调用。

安装步骤

  1. 下载仓库: 将 GitHub 仓库 'cursor-db-mcp' 克隆到本地。
  2. 运行安装脚本: 在仓库根目录下,打开终端并执行 'python install.py'。
    • 该脚本将创建并配置一个 Python 虚拟环境 '.venv',并安装所有必要的依赖包。

服务器配置

为了让 MCP 客户端(如 Cursor IDE 或 Claude)连接到此服务器,您需要配置客户端的 MCP Server 设置。以下是一个配置示例(JSON 格式):

{
  "serverName": "Cursor DB MCP",  // 服务器名称,可以自定义
  "command": "<虚拟环境Python路径>/uv", // 指向虚拟环境中的 uv 可执行文件,例如:/path/to/cursor-db-mcp/.venv/bin/uv (macOS/Linux) 或 C:\path\to\cursor-db-mcp\.venv\Scripts\uv.exe (Windows)
  "args": [
    "run",
    "--with",
    "mcp[cli]",
    "mcp",
    "run",
    "<仓库路径>/cursor-db-mcp-server.py" // 指向服务器脚本 cursor-db-mcp-server.py 的绝对路径,例如:/path/to/cursor-db-mcp/cursor-db-mcp-server.py
  ]
}

配置参数说明:

  • '"serverName"': MCP 服务器的名称,在客户端中显示,您可以自定义。
  • '"command"': 启动 MCP 服务器的命令。这里使用 'uv run' 来运行 Python 脚本,'uv' 需要安装在虚拟环境中('install.py' 脚本会尝试安装)。请务必替换 '<虚拟环境Python路径>' 为您实际的虚拟环境路径。
  • '"args"': 传递给 'uv run' 命令的参数列表。
    • '"run"': 'uv' 的子命令,用于运行程序。
    • '"--with"': 'mcp[cli]' 表示运行环境需要包含 'mcp[cli]' 及其依赖。
    • '"mcp"': 调用 'mcp' 命令。
    • '"run"': 'mcp' 的子命令,用于运行 MCP 服务器。
    • '"<仓库路径>/cursor-db-mcp-server.py"': MCP 服务器脚本的绝对路径,请替换为实际路径。

重要提示:

  • 请确保 '<虚拟环境Python路径>/uv' 和 '<仓库路径>/cursor-db-mcp-server.py' 替换为您的实际路径。您可能需要先激活虚拟环境,然后使用 'which uv' (macOS/Linux) 或 'where uv' (Windows) 命令来查找 'uv' 的完整路径。
  • 某些 MCP 客户端可能需要指定 Python 解释器的完整路径而不是 'uv'。如果使用 'uv run' 遇到问题,可以尝试将 '"command"' 更改为虚拟环境中的 Python 解释器路径,并将 '"args"' 调整为直接运行 'cursor-db-mcp-server.py'。

基本使用方法

  1. 配置 MCP 客户端: 在您的 MCP 客户端(如 Cursor IDE)中,根据上述“服务器配置”部分添加新的 MCP 服务器,并填入正确的配置信息。
  2. 连接服务器: 客户端配置完成后,通常会自动尝试连接到 MCP 服务器。请确保服务器配置正确,且服务器脚本 'cursor-db-mcp-server.py' 可以正常运行。
  3. 使用 AI 助手提问: 连接成功后,您就可以在 AI 助手中提出与 Cursor IDE 项目数据相关的问题了。例如:
    • "列出我的 Cursor 项目"
    • "显示项目 'my-project' 的聊天记录"
    • "查询项目 'my-project' 的 ItemTable 表格中关于 'settings' 的键值"

具体可用的资源和工具请参考仓库 'README.md' 文件中 "Available Resources" 和 "Available Tools" 部分的说明。

信息

分类

数据库与文件