使用说明

项目简介

'axiom-mcp-server-axiom' 是一个基于 Model Context Protocol (MCP) 构建的服务器，它允许 AI 智能体通过 Axiom Processing Language (APL) 查询和访问 Axiom 数据平台的数据。

主要功能点

查询 Axiom 数据集 (queryApl): 允许 AI 智能体使用 APL 语言查询 Axiom 平台上的数据集，获取数据分析结果。APL 是一种强大的查询语言，可以进行数据过滤、聚合、转换等操作。
列出 Axiom 数据集 (listDatasets): 允许 AI 智能体获取 Axiom 平台上可用的数据集列表，方便用户了解和选择需要查询的数据集。

安装步骤

下载预编译二进制文件: 访问 releases page 下载最新版本的预编译二进制文件。根据你的操作系统选择合适的版本。
或者从源代码安装: 如果你的电脑上安装了 Go 语言环境，可以使用以下命令从源代码安装：
```
go install github.com/axiomhq/axiom-mcp@latest
```
安装完成后，'axiom-mcp' 可执行文件通常会位于 '$GOPATH/bin' 目录下。

服务器配置

MCP 服务器需要配置 Axiom API 的连接信息以及速率限制等参数。你可以通过以下三种方式进行配置：配置文件、命令行参数或环境变量。

为了让 MCP 客户端（如 Claude）连接到 'axiom-mcp-server-axiom' 服务器，你需要在客户端的配置文件中指定服务器的启动命令 (command) 及其参数 (args)。以下是针对 Claude 客户端 'claude_desktop_config.json' 文件的配置示例：

{
  "mcpServers": {
    "axiom": {
      "command": "/path/to/your/axiom-mcp-binary",  // 替换为 axiom-mcp 二进制文件的实际路径，例如: "/path/to/axiom-mcp"
      "args" : ["--config", "/path/to/your/config.txt"], // 替换为 config.txt 配置文件的实际路径，例如: "/path/to/config.txt"。 如果你选择使用命令行参数或环境变量配置，则可以省略此参数。
      "env": {
        "AXIOM_TOKEN": "xaat-your-token",         // (可选，但推荐在配置文件或环境变量中配置) 你的 Axiom API Token，用于身份验证。请替换为你的实际 Token。
        "AXIOM_URL": "https://api.axiom.co",          // (可选) Axiom API 的 URL，默认为 https://api.axiom.co。如果使用 Axiom Cloud，则无需修改。
        "AXIOM_ORG_ID": "your-org-id"           // (可选) 你的 Axiom Organization ID。如果使用了组织 ID，请配置此项。
      }
    }
  }
}

配置文件 (config.txt 示例): 创建一个名为 'config.txt' 的文件，并填入以下内容，替换为你自己的 Axiom API Token 和其他配置信息：

token xaat-your-token
url https://api.axiom.co
org-id your-org-id  # 如果使用了组织 ID，请配置此项
query-rate 1        # 查询操作的速率限制，每秒请求数
query-burst 1       # 查询操作的突发请求数
datasets-rate 1     # 列出数据集操作的速率限制，每秒请求数
datasets-burst 1    # 列出数据集操作的突发请求数

命令行参数配置: 你也可以直接在启动 'axiom-mcp' 服务器时使用命令行参数配置，例如：

/path/to/axiom-mcp-binary \
  -token xaat-your-token \
  -url https://api.axiom.co \
  -org-id your-org-id \
  -query-rate 1 \
  -query-burst 1 \
  -datasets-rate 1 \
  -datasets-burst 1

环境变量配置: 还可以使用环境变量配置，例如：

export AXIOM_TOKEN=xaat-your-token
export AXIOM_URL=https://api.axiom.co
export AXIOM_ORG_ID=your-org-id
export AXIOM_QUERY_RATE=1
export AXIOM_QUERY_BURST=1
export AXIOM_DATASETS_RATE=1
export AXIOM_DATASETS_BURST=1
/path/to/axiom-mcp-binary

基本使用方法

配置 Axiom 连接: 根据上述 "服务器配置" 中的说明，选择一种方式配置 Axiom API Token, URL 和 Organization ID。

启动 MCP 服务器: 打开终端，运行 'axiom-mcp' 二进制文件。如果使用了配置文件，请确保使用 '--config' 参数指定配置文件路径。例如：

/path/to/axiom-mcp-binary --config /path/to/your/config.txt

配置 MCP 客户端: 打开支持 MCP 协议的客户端（例如 Claude 桌面应用），根据客户端的指引，配置连接到 'axiom-mcp-server-axiom' 服务器。通常需要提供服务器的启动命令和参数，参考 "服务器配置" 中的 'claude_desktop_config.json' 示例。
使用 AI 智能体: 在 MCP 客户端中，你就可以指示 AI 智能体使用 'queryApl' 工具来查询 Axiom 数据，例如，你可以对 Claude 说 "使用 axiom 工具查询最近一小时的错误日志"。AI 智能体将调用 'queryApl' 工具，并使用 APL 查询 Axiom 数据，然后将结果返回给你。你也可以使用 'listDatasets' 工具让 AI 智能体列出可用的数据集。

关键词