From 1b46021e8cc0c89a9a517c6e8b9c58b90c15949d Mon Sep 17 00:00:00 2001 From: zhangguoyun Date: Tue, 16 Dec 2025 10:51:41 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=B7=BB=E5=8A=A0=20README=20=E6=96=87?= =?UTF-8?q?=E4=BB=B6=EF=BC=8C=E6=8F=8F=E8=BF=B0=E9=A1=B9=E7=9B=AE=E5=8A=9F?= =?UTF-8?q?=E8=83=BD=E4=B8=8E=E4=BD=BF=E7=94=A8=E6=96=B9=E6=B3=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e29d67b --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Local Open MCP + +这是一个 Model Context Protocol (MCP) 服务器,旨在赋予 LLM 打开本地文件、文件夹、URL 和应用程序的能力。 + +## 功能特性 + +该服务器注册了以下 MCP 工具,供客户端调用: + +- **`open_url`**: 在默认浏览器中打开指定的 URL 链接。 +- **`open_file`**: 使用系统默认程序打开指定的本地文件。 +- **`open_directory`**: 在文件资源管理器中打开指定的本地文件夹。 +- **`open_app`**: 打开指定的本地应用程序,支持传递启动参数。 + +## 安装 + +首先,克隆项目并安装依赖: + +```bash +npm install +``` + +## 使用方法 + +### 启动服务器 + +服务器通过标准输入/输出 (stdio) 进行通信。通常由 MCP 客户端(如 Claude Desktop 或其他支持 MCP 的应用)自动启动。 + +```bash +npm start +``` + +### 开发与调试 + +你可以使用 MCP Inspector 来调试和测试服务器的功能: + +```bash +npm run dev +``` + +这将启动 MCP Inspector 界面,你可以在其中查看注册的工具并进行交互测试。 + +## 配置 + +在你的 MCP 客户端配置文件(例如 Claude Desktop 的 `claude_desktop_config.json`)中添加以下配置以使用此服务器: + +```json +{ + "mcpServers": { + "local-open": { + "command": "node", + "args": ["/path/to/local-open-mcp/index.js"] + } + } +} +``` + +请确保将 `/path/to/local-open-mcp/index.js` 替换为实际的绝对路径。 + +## License + +ISC