Project Opener MCP Server 使用说明
项目简介
Project Opener MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,它扩展了 LLM 应用(如 Claude Desktop)与本地项目文件的交互能力。通过注册工具和资源,该服务器允许用户通过 LLM 客户端方便地打开本地项目、查询项目信息,从而提升开发效率和智能化工作流程。
主要功能点
- 打开项目 (Open Project): 允许用户指定项目路径,并在默认的代码编辑器(VS Code 或 Visual Studio)中打开该项目。服务器会根据项目类型(是否为 Visual Studio 项目)选择合适的编辑器启动命令。
- 获取项目信息 (Get Project Info): 提供查询特定项目信息的功能。(仓库中只实现了 'list_projects' 资源,README.md 中提到的 'Get Project Info' 工具可能尚未实现或描述有误,此处根据代码实际情况描述为列出项目)
- 列出项目 (List Projects): 允许用户获取指定项目目录下的所有项目列表,返回项目名称、路径和项目类型(是否为 C# 项目)等信息。
安装步骤
- 安装 Node.js: 确保你的系统已安装 Node.js (v18.x 或更高版本)。你可以从 nodejs.org 下载并安装。
- 克隆仓库: 使用 'git clone https://github.com/jlmelis/project-opener-mcp' 命令克隆该仓库到本地。
- 安装依赖: 进入克隆的仓库目录,运行 'npm install' 命令安装项目依赖。
- 构建项目: 运行 'npm run build' 命令构建项目,生成 'build/index.js' 文件。
服务器配置
要将 Project Opener MCP Server 添加到 MCP 客户端(例如 Claude Desktop),你需要配置服务器的启动命令。以下是配置信息(JSON 格式):
{ "serverName": "project-opener", // MCP 服务器名称,可以自定义 "command": "node", // 启动服务器的命令,这里使用 Node.js 运行时 "args": ["build/index.js"] // 启动命令的参数,指向构建后的服务器入口文件 }
将以上 JSON 配置添加到你的 MCP 客户端的服务器配置中。例如,在 Claude Desktop 中,你可以在 "Settings > MCP Servers" 中添加一个新的服务器,并将上述配置填入。
基本使用方法
成功配置并启动服务器后,你可以在 MCP 客户端中使用以下功能:
-
列出项目: 客户端可以通过请求 'projects://<项目目录路径>/list' 资源来获取指定目录下的项目列表。例如,如果你的项目目录是 '/Users/yourname/projects',则可以请求 'projects:///Users/yourname/projects/list' 资源,服务器会返回该目录下所有子目录的信息。
-
打开项目: 客户端可以调用 'open_project' 工具来打开项目。你需要提供以下参数:
- 'projectName': 要打开的项目名称 (子目录名)。
- 'projectsDir': 项目所在的根目录路径。
例如,要打开名为 "my-project",根目录为 '/Users/yourname/projects' 的项目,你可以构造如下的工具调用请求 (具体请求格式取决于 MCP 客户端):
{ "tool": "open_project", "arguments": { "projectName": "my-project", "projectsDir": "/Users/yourname/projects" } }服务器会尝试在 VS Code 或 Visual Studio 中打开该项目,并返回操作结果。
注意: 'projectsDir' 参数需要根据你的实际项目根目录进行调整。路径需要是服务器能够访问到的本地文件系统路径。
信息
分类
开发者工具