使用说明

项目简介

该项目 'zed-commands-context-server' 是一个 Zed 编辑器的扩展,它作为一个桥梁,使得 Zed 可以连接到一个独立的 MCP 服务器(很可能就是 'mcp-server-commands' 项目,虽然本仓库中没有直接包含服务器代码)。这个扩展的主要目的是让用户能够在 Zed 编辑器中使用命令行的输出来丰富发送给 LLM 的 Prompt 上下文。虽然仓库本身不包含完整的 MCP 服务器实现,但它通过 Zed 扩展的形式,定义了如何启动一个外部的 MCP 服务器,并让 Zed 编辑器能够与之通信,从而利用 MCP 服务器提供的 Prompt 模板功能。

注意: 本仓库 'zed-commands-context-server' 实际上是一个 MCP 客户端(Zed 编辑器扩展),它负责启动和配置 MCP 服务器。真正的 MCP 服务器代码应该在 'SERVER_DEV_PATH' 指定的路径所指向的项目中(根据路径 '/Users/wes/repos/github/g0t4/mcp-server-commands/build/index.js' 推测,服务器项目可能名为 'mcp-server-commands')。

主要功能点

  • 启动外部 MCP 服务器: 通过 Zed 扩展配置,可以启动一个独立的 MCP 服务器进程。
  • Prompt 模板支持: 利用 MCP 服务器提供的 Prompt 模板功能,允许用户在 Zed 编辑器中使用预定义的 Prompt 结构,并可能将命令行的输出注入到 Prompt 中,以增强 LLM 的上下文信息。
  • Zed 编辑器集成: 作为 Zed 编辑器的扩展,无缝集成到 Zed 的上下文服务器管理机制中。

请注意,根据仓库信息,该扩展目前主要关注 Prompt 模板功能,Tool 功能可能尚未支持。

安装步骤

由于这是一个 Zed 编辑器的扩展,安装步骤主要涉及如何将此扩展配置到 Zed 编辑器中。 更重要的是,你需要确保在 'SERVER_DEV_PATH' 指定的位置存在一个可运行的 MCP 服务器实现。

  1. 获取扩展代码: 从 GitHub 仓库 'https://github.com/g0t4/zed-commands-context-server' 获取 'src/extension.rs' 文件。
  2. 构建 Zed 扩展 (如果需要): 根据 Zed 扩展的开发流程,可能需要编译 'extension.rs' 文件以生成 Zed 可以加载的扩展。 具体步骤请参考 Zed 官方扩展开发文档。
  3. 配置 Zed 扩展: 将构建好的 Zed 扩展安装或配置到 Zed 编辑器中。 具体的扩展安装/配置方法请参考 Zed 官方文档。
  4. 准备 MCP 服务器代码: 关键步骤! 根据 'extension.rs' 中 'SERVER_DEV_PATH' 的配置:
    const SERVER_DEV_PATH: &str = "/Users/wes/repos/github/g0t4/mcp-server-commands/build/index.js";
    你需要:
    • 找到 'mcp-server-commands' 项目: 仓库路径 '/Users/wes/repos/github/g0t4/mcp-server-commands' 表明可能存在一个名为 'mcp-server-commands' 的项目在 'g0t4' 用户的 GitHub 仓库下。 你可能需要自行查找并获取该项目。(重要:本仓库 'zed-commands-context-server' 自身不包含服务器代码,服务器代码很可能在 'mcp-server-commands' 项目中。
    • 构建服务器代码: 如果 'mcp-server-commands' 项目是一个 Node.js 项目(根据 'index.js' 推测),你可能需要在该项目目录下执行 'npm install' 和 'npm build' 或类似的命令来安装依赖并构建服务器代码。
    • 确认服务器构建输出路径: 确认构建后的服务器入口文件路径是否与 'SERVER_DEV_PATH' ('/Users/wes/repos/github/g0t4/mcp-server-commands/build/index.js') 一致。如果路径不一致,你需要修改 'zed-commands-context-server' 扩展代码中的 'SERVER_DEV_PATH'。

服务器配置 (MCP 客户端 - Zed 编辑器 配置)

在 Zed 编辑器中配置 MCP 服务器连接,你需要编辑 Zed 的配置文件 (通常是 'config.json' 或 Zed 的设置界面)。 以下是一个可能的 'context_servers' 配置示例 (JSON 格式),你需要将其添加到 Zed 的配置文件中。

{
  "context_servers": [
    {
      "name": "commands-context-server",  // 服务器名称,可以自定义
      "command": "node",                 // 启动服务器的命令,这里假设服务器是 Node.js 应用
      "args": [                          // 启动服务器的参数
        "/Users/wes/repos/github/g0t4/mcp-server-commands/build/index.js" // MCP 服务器入口文件路径
        // 注意:你需要将此路径替换为你实际的 MCP 服务器入口文件路径。
        // 如果你找到了 'mcp-server-commands' 项目并成功构建,请将路径指向该项目构建输出的 'index.js' 文件。
      ],
      "env": []                           // 环境变量,当前配置为空
    }
  ]
}

配置说明:

  • 'name': 上下文服务器的名称,在 Zed 编辑器中用于标识和管理不同的上下文服务器连接。你可以自定义名称,例如 '"commands-context-server"' 或 '"my-mcp-commands-server"'。
  • 'command': 启动 MCP 服务器进程的可执行命令。 由于 'SERVER_DEV_PATH' 指向 'index.js' 文件,这里很可能是 '"node"',表示使用 Node.js 运行时来执行 JavaScript 服务器代码。
  • 'args': 传递给 'command' 的参数列表。
    • 关键参数是 MCP 服务器入口文件路径请务必将示例路径 '/Users/wes/repos/github/g0t4/mcp-server-commands/build/index.js' 替换为你实际的 MCP 服务器入口文件路径。 这通常是你构建 'mcp-server-commands' 项目后生成的 'index.js' 文件路径。
  • 'env': 设置传递给 MCP 服务器进程的环境变量。 当前配置为空,但如果 MCP 服务器需要特定的环境变量(例如数据库连接信息等),你可以在这里添加。

重要提示:

  • 路径调整: 示例配置文件中的 '/Users/wes/repos/github/g0t4/mcp-server-commands/build/index.js' 路径是 开发环境路径,你需要将其 替换为你实际部署或构建的 MCP 服务器入口文件路径
  • MCP 服务器项目: 本仓库 'zed-commands-context-server' 只是 Zed 扩展,不包含完整的 MCP 服务器代码。 你需要 自行获取、构建和运行 'mcp-server-commands' 项目 (或类似的 MCP 服务器项目),并将其入口文件路径配置到 Zed 扩展的 'context_servers' 配置中。

基本使用方法

  1. 启动 MCP 服务器: 确保你配置的 MCP 服务器('mcp-server-commands' 或其他)已经成功构建并 正在运行。 Zed 扩展本身只是启动服务器的客户端,服务器需要独立运行。
  2. 配置 Zed 上下文服务器: 将上述 JSON 配置添加到 Zed 的配置文件中,并确保路径配置正确。
  3. 在 Zed 中使用 Prompt 功能: 在 Zed 编辑器中,当需要使用 LLM 功能时,应该可以通过 Zed 的 Prompt 功能调用配置的上下文服务器。 具体的使用方式取决于 Zed 编辑器的 Prompt 功能集成方式。 你可能需要在 Zed 的 Prompt 输入界面选择或指定使用 '"commands-context-server"' (或你配置的 'name') 上下文服务器提供的 Prompt 模板。
  4. 利用命令输出: 根据 'README.md' 的描述,该服务器的目的是将命令行的输出集成到 Prompt 模板中。 你需要查看 'mcp-server-commands' 项目 (如果能找到) 或类似的 MCP 服务器项目的文档,了解如何定义 Prompt 模板,以及如何使用特定的 Prompt 模板来执行命令并将输出注入到 Prompt 中。

总结: 'zed-commands-context-server' 是 Zed 编辑器连接 MCP 服务器的桥梁。 要使其工作,你需要 独立准备和运行一个兼容的 MCP 服务器 (很可能是 'mcp-server-commands' 项目),并将服务器的启动信息正确配置到 Zed 编辑器的 'context_servers' 中。 该扩展主要利用 MCP 服务器的 Prompt 模板功能,以命令行的输出增强 LLM 的上下文。

信息

分类

开发者工具