使用说明

项目简介

Axiom Context Server 是一个为 Zed 代码编辑器设计的扩展,旨在为 Zed 的 AI 助手提供上下文信息服务。它作为一个独立的后台服务运行,允许 AI 助手访问项目相关的上下文数据,从而提升代码补全、代码建议等 AI 功能的准确性和效率。虽然仓库名称为 'axiom-mcp',但根据仓库内容和描述,它更像是 Axiom 公司内部 Zed 编辑器使用的上下文服务器,目前不能完全确定它是否完全实现了通用的 Model Context Protocol (MCP) 标准,更偏向于一个定制化的上下文服务方案。

主要功能点

  • 为 Zed AI 助手提供上下文: 作为 Zed 编辑器的扩展,核心目的是增强 Zed AI 助手的能力,为其提供代码编辑上下文之外的更多信息。
  • 可配置的数据访问: 通过配置 'token' 和 'url',推测该服务可以连接到 Axiom 内部的数据服务,获取项目相关的上下文数据。
  • 速率限制: 支持配置 'query_rate', 'query_burst', 'datasets_rate', 'datasets_burst' 等参数,表明具有速率限制功能,用于控制数据访问频率,保护后端服务。
  • 可自定义启动命令: 允许用户在 Zed 的 'settings.json' 中自定义服务器的启动命令和参数,提供了灵活性。

安装步骤

  1. 安装 Zed 编辑器: 首先需要安装 Zed 代码编辑器。
  2. 安装 Axiom Context Server 扩展: 此仓库是 Zed 编辑器的扩展,需要将其安装到 Zed 编辑器中。具体的安装方式可能需要参考 Zed 编辑器的扩展安装文档。通常,Zed 编辑器可能支持从本地路径或通过包管理器安装扩展。
  3. 配置 Axiom Context Server: 安装完成后,需要在 Zed 编辑器的 'settings.json' 文件中配置 Axiom Context Server。

服务器配置

MCP 客户端(例如 Zed 编辑器中的 AI 助手)需要配置 MCP 服务器的启动命令才能连接。以下是在 Zed 的 'settings.json' 中配置 'axiom-mcp' 上下文服务器的示例:

{
  "context_servers": {
    "axiom-mcp": { // 服务器名称,在 Zed 编辑器中用于标识和引用
      "settings": {
        // "config_file": "/path/to/your/config.txt", // (可选) 配置文件路径,如果服务器需要额外的配置文件
        "token": "YOUR_API_TOKEN", //  API Token,用于身份验证,访问 Axiom 数据服务
        "url": "https://api.axiom.example.com", // (可选) Axiom API 的 URL,如果需要连接到特定的 Axiom 服务
        // "query_rate": 1.0, // (可选) 查询速率限制
        // "query_burst": 10, // (可选) 查询突发限制
        // "datasets_rate": 0.5, // (可选) 数据集访问速率限制
        // "datasets_burst": 5  // (可选) 数据集访问突发限制
      },
      "command": {
        "cmd": "/path/to/axiom-mcp", //  axiom-mcp 服务器可执行文件的路径,需要替换为实际路径
        "args": [ // 启动参数
          "--config", "/path/to/your/config.txt" // (可选)  如果 settings 中没有 config_file,则使用此参数指定配置文件路径
        ]
      }
    }
  }
}

配置说明:

  • '"context_servers"': Zed 编辑器用于配置上下文服务器的顶级配置项。
  • '"axiom-mcp"': 自定义的服务器名称,用于在 Zed 编辑器中引用此配置。
  • '"settings"': 服务器特定的设置,会作为参数传递给服务器。
    • '"token"': 必填,用于 Axiom 服务身份验证的 API Token。你需要替换为你的有效 Token。
    • '"url"': 可选,Axiom API 的 URL。如果使用默认 Axiom 服务,可能不需要配置。
    • '"config_file"': 可选,服务器配置文件的路径。可以通过 'settings' 中的 'config_file' 或 'command.args' 中的 '--config' 参数指定。
    • '"_rate"' 和 '"_burst"': 可选,速率限制相关参数,用于控制 API 请求的频率,根据需要配置。
  • '"command"': 定义如何启动 Axiom Context Server。
    • '"cmd"': 必填,'axiom-mcp' 服务器可执行文件的绝对路径。你需要将 '/path/to/axiom-mcp' 替换为 'axiom-mcp' 可执行文件在你系统中的实际位置。 注意:仓库中只包含了扩展的代码,并没有提供 'axiom-mcp' 服务器的可执行文件。你需要自行构建或获取 'axiom-mcp' 服务器端程序。 根据 'README.md',如果未指定自定义命令,扩展程序会在当前目录查找 'axiom-mcp' 可执行文件。
    • '"args"': 可选,传递给 'axiom-mcp' 服务器的命令行参数。示例中使用了 '--config' 参数,用于指定配置文件路径,但这取决于 'axiom-mcp' 服务器端程序是否接受 '--config' 参数。

重要提示:

  • 缺少服务器端程序: 此仓库 仅包含 Zed 编辑器扩展的代码, 并没有提供 'axiom-mcp' 服务器端可执行文件的源代码或预编译版本。 你需要自行查找、构建或获取 'axiom-mcp' 服务器端程序才能真正运行此上下文服务。
  • 定制化服务: 根据配置项和描述,该服务更像是 Axiom 内部使用的定制化上下文服务,可能不完全符合通用的 MCP 标准。
  • 配置依赖后端服务: 'token' 和 'url' 配置项表明该服务依赖于 Axiom 提供的后端数据服务。你需要拥有 Axiom 服务的账号和 API Token 才能正常使用。

基本使用方法

  1. 确保已安装 Zed 编辑器和 Axiom Context Server 扩展。
  2. 根据上述 "服务器配置" 部分,在 Zed 的 'settings.json' 文件中配置 'axiom-mcp' 上下文服务器,并确保 'axiom-mcp' 服务器端程序已正确安装并可执行,且路径配置正确。
  3. 启动 Zed 编辑器。
  4. 当你在 Zed 编辑器中使用 AI 助手功能时,配置的 Axiom Context Server 将会自动为 AI 助手提供上下文信息,提升其功能。

由于缺少服务器端代码,无法进行更深入的分析和使用指导。 以上说明基于仓库提供的扩展代码和描述进行推测。

信息

分类

开发者工具