Hide MCP服务器使用说明

项目简介

Hide MCP 服务器是为 headless IDE Hide 构建的后端服务，它实现了 Model Context Protocol (MCP)，旨在为大型语言模型 (LLM) 客户端提供上下文信息和工具能力。通过此服务器，LLM 应用可以安全、可扩展地访问和操作远程资源，并执行外部功能。

主要功能点

资源管理: 支持将 Hide 项目作为资源进行管理和访问，允许客户端读取和操作项目文件。
工具集成: 内置文本编辑器和 Bash 终端两种实用工具，扩展了 LLM 的能力边界，使其能够进行代码编辑和系统操作。
- 文本编辑器: 提供文件查看、编辑、创建、替换、插入行等功能，支持代码行号显示和编辑历史记录。
- Bash 终端: 提供持久化的 Bash Shell 环境，预装 Linux/Python 常用软件包，支持后台进程和输出截断，方便 LLM 进行系统级任务。
MCP 协议标准: 遵循 MCP 协议，使用 JSON-RPC 通信，保证了与 MCP 客户端的兼容性和互操作性。
多种传输协议: 支持 Stdio 和 SSE 两种传输协议，可灵活适应不同的部署环境。
易于调试: 推荐使用 MCP Inspector 进行调试，提升开发效率。

安装步骤

克隆仓库: 将 GitHub 仓库 'https://github.com/hide-org/hide-mcp' 克隆到本地。

git clone https://github.com/hide-org/hide-mcp
cd hide-mcp

安装依赖: 使用 'uv' (或 'pip') 安装项目依赖。

uv sync  # 推荐使用 uv
# 或
# pip install -r requirements.txt

服务器配置

MCP 客户端（例如 Claude）需要配置 MCP 服务器的启动命令和参数才能连接。以下是针对 开发环境/未发布服务器 的配置示例，请将以下 JSON 配置添加到 Claude 的配置文件中：

Claude 配置文件路径:

MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置信息 (JSON):

{
  "mcpServers": {
    "hide-mcp": {
      "command": "uv",  // 启动命令，这里使用 uv 运行器
      "args": [
        "--directory",  // 指定工作目录
        "/path/to/hide-mcp",  // 替换为 hide-mcp 仓库的实际路径
        "run",          // uv 的 run 命令
        "hide-mcp"      // 运行 hide-mcp 入口点
      ]
    }
  }
}

参数注释:

'"hide-mcp"': MCP 服务器的名称，可以自定义。
'"command": "uv"': 指定用于启动服务器的命令，这里使用 'uv' 运行器。您需要确保系统已安装 'uv'。如果使用 pip，可以替换为 '"python"'。
'"args"': 命令参数列表。
- '"--directory"': 指定工作目录为 hide-mcp 仓库的根目录。请将 '"/path/to/hide-mcp"' 替换为您的实际仓库路径。
- '"run"': 'uv' 运行器的子命令，用于运行 Python 模块。
- '"hide-mcp"': 指定要运行的 Python 模块入口点，对应 'hide_mcp/init.py'。

注意:

请根据您的实际环境修改 '"/path/to/hide-mcp"' 为仓库的绝对路径。
如果您使用 'pip' 而不是 'uv'，可以将 '"command"' 更改为 '"python"'，并将 '"args"' 相应调整。

基本使用方法

启动服务器: 在 hide-mcp 仓库目录下，使用以下命令启动 MCP 服务器 (默认使用 stdio 传输协议):

uv run hide-mcp server
# 或使用 SSE 传输协议，并指定端口 (例如 8945)
uv run hide-mcp server --transport sse --port 8945

配置 MCP 客户端: 将上述 服务器配置 (JSON) 添加到 MCP 客户端 (例如 Claude) 的配置文件中，并确保配置中的路径正确。
连接和使用: 启动 MCP 客户端，客户端应该能够自动连接到 Hide MCP 服务器。之后，您就可以在客户端中使用服务器提供的工具和资源了。例如，在 Claude 中，您可以指示 Claude 使用 "bash" 工具执行 shell 命令，或使用 "str_replace_editor" 工具编辑文件。

调试: 为了更好的调试体验，推荐使用 MCP Inspector。按照 README.md 中的 "Debugging" 部分的说明启动 MCP Inspector。

关键词