关键词

Axiom数据查询APL日志分析AI智能体

使用说明

项目简介

Axiom MCP Server 是一个实现了 Model Context Protocol (MCP) 协议的服务器，专为 Axiom 数据平台设计。它使得 AI 智能体，如 Claude，能够通过 MCP 协议以标准化的方式查询和访问存储在 Axiom 中的日志和事件数据。该服务器目前主要提供数据查询和数据集列表功能，尚不支持资源和 Prompt 模板功能。

主要功能点

  • 数据查询 (queryApl): 允许 AI 智能体执行 Axiom Processing Language (APL) 查询语句，从而检索 Axiom 数据集中的信息。APL 是一种强大的查询语言，支持过滤、聚合、时间范围限制等多种操作，可以帮助 AI 智能体深入分析数据。
  • 数据集列表 (listDatasets): 允许 AI 智能体获取 Axiom 平台上可用的数据集列表，方便智能体了解可以查询的数据范围。
  • 速率限制: 对查询和数据集列表操作实施速率限制，防止滥用并保障服务器稳定运行。

安装步骤

  1. 下载预编译版本 (推荐): 访问 Releases 页面 下载适用于您操作系统的最新预编译二进制文件。

  2. 从源代码安装: 确保您已安装 Go 语言环境。打开终端并执行以下命令：

    go install github.com/axiomhq/axiom-mcp@latest

    安装成功后，'axiom-mcp' 可执行文件通常会位于 '$GOPATH/bin' 目录下。请确保 '$GOPATH/bin' 已添加到您的系统环境变量 'PATH' 中。

服务器配置

MCP 服务器需要配置 Axiom 平台的访问凭证和连接信息才能正常工作。配置方法有多种，以下是配置 Claude 客户端所需的 'claude_desktop_config.json' 文件示例，展示了如何配置 Axiom MCP Server 的启动命令 (command) 及其参数 (args)。

{
  "mcpServers": {
    "axiom": {  //  服务器名称，可以自定义，例如 "axiom"
      "command": "/path/to/your/axiom-mcp-binary",  //  axiom-mcp 服务器可执行文件的路径。如果您通过 go install 安装，且 $GOPATH/bin 已添加到 PATH，则可以直接使用 "axiom-mcp"
      "args" : ["--config", "/path/to/your/config.txt"], //  传递给 axiom-mcp 服务器的命令行参数。这里使用 --config 参数指定配置文件路径，您也可以选择其他配置方式，例如直接使用命令行参数或环境变量。
      "env": { // (可选) 环境变量配置，如果选择环境变量配置方式，可以在这里设置。
        // "AXIOM_TOKEN": "xaat-your-token",
        // "AXIOM_URL": "https://api.axiom.co",
        // "AXIOM_ORG_ID": "your-org-id"
      }
    }
  }
}

配置文件 (config.txt) 示例:

如果您选择使用配置文件方式，请创建 'config.txt' 文件，并填入以下内容，替换为您实际的 Axiom 访问信息：

token xaat-your-token  # 您的 Axiom API Token
url https://api.axiom.co  # (可选) 您的 Axiom API URL，通常使用默认值即可
org-id your-org-id      # (可选) 您的 Axiom Organization ID，如果需要可以配置
query-rate 1           # 查询速率限制，每秒最多处理多少个查询请求
query-burst 1           # 查询突发请求数限制
datasets-rate 1        # 数据集列表操作速率限制
datasets-burst 1        # 数据集列表操作突发请求数限制

其他配置方式:

除了配置文件，您还可以选择以下方式配置 Axiom MCP Server：

  • 命令行 Flags: 直接在 'command' 的 'args' 数组中添加命令行参数，例如： 
    "args": ["-token", "xaat-your-token", "-url", "https://api.axiom.co"]
  • 环境变量: 在 'env' 字段中设置环境变量，或者在运行 'axiom-mcp' 服务器的环境中设置环境变量。

基本使用方法

  1. 配置 Axiom MCP Server: 根据上述 "服务器配置" 章节，选择一种方式配置 Axiom MCP Server，并确保服务器成功启动。
  2. 配置 MCP 客户端 (例如 Claude): 修改 Claude 客户端的配置文件 'claude_desktop_config.json'，添加或修改 'mcpServers' 部分，配置 Axiom MCP Server 的连接信息，如 "服务器配置" 章节所示。
  3. 在 Claude 中使用: 配置完成后，Claude 客户端应该能够检测到 Axiom MCP Server 提供的工具。您可以在 Claude 中指示它使用 'queryApl' 工具执行 APL 查询，或使用 'listDatasets' 工具查看可用的数据集。

注意: 目前 Axiom MCP Server 仅实现了 'queryApl' 和 'listDatasets' 两个工具，暂不支持 MCP 协议中的资源 (Resources) 和 Prompt 模板 (Prompts) 功能。

信息

分类

AI与计算

访问项目