使用说明

项目简介

Hex MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在连接大型语言模型 (LLM) 应用和 Hex 数据分析平台。它允许 LLM 通过标准化的 MCP 协议调用 Hex 的各项功能，例如浏览项目、搜索项目、运行项目等，从而实现更智能化的数据分析工作流。

主要功能点

项目列表与搜索: 允许 LLM 获取 Hex 平台上的项目列表，并支持根据关键词搜索项目。
项目详情: 提供查看指定 Hex 项目详细信息的功能。
项目运行管理: 支持查看项目运行状态、运行历史，以及执行和取消项目运行。

安装步骤

安装 'hex-mcp': 推荐使用 'uv' 或 'pip' 进行安装。

uv add hex-mcp
# 或
pip install hex-mcp

验证安装: 安装完成后，可以运行以下命令检查是否安装成功。
```
hex-mcp --version
```

服务器配置 (MCP 客户端配置)

对于 MCP 客户端（例如 Cursor），需要配置 MCP 服务器的连接信息。在你的项目根目录下创建 '.cursor/mcp.json' 文件，并添加以下配置：

{
  "mcpServers": {
    "hex-mcp": {  //  服务器名称，可以自定义
      "command": "hex-mcp", //  启动服务器的命令，假设 hex-mcp 已添加到系统 PATH
      "args": ["run"]        //  启动命令的参数，此处为 "run"
    }
  }
}

配置参数说明:

'mcpServers': 定义可用的 MCP 服务器列表。
'hex-mcp': 为当前 Hex MCP 服务器配置项命名，可以根据需要自定义名称。
'command': 指定启动 Hex MCP 服务器的命令。这里假设 'hex-mcp' 命令可以直接在终端中执行（已添加到系统 PATH）。如果未使用 'uv' 安装，且 'hex-mcp' 命令不在 PATH 中，或者你想使用 'uv' 运行，请参考仓库 README 修改配置。
'args': 传递给 'command' 的参数。'["run"]' 参数指示 'hex-mcp' 运行 MCP 服务器。

如果 'hex-mcp' 命令不在 PATH 中，或者使用 'uv' 安装，可以使用以下配置:

{
  "mcpServers": {
    "hex-mcp": {
      "command": "uv",
      "args": ["run", "hex-mcp", "run"]
    }
  }
}

基本使用方法

配置 Hex API 密钥: Hex MCP Server 需要 Hex API 密钥才能访问你的 Hex 项目。可以通过以下两种方式配置：
- 使用 'config' 命令 (推荐):
```
hex-mcp config --api-key "YOUR_HEX_API_KEY"
```
  将 '"YOUR_HEX_API_KEY"' 替换为你的 Hex API 密钥。API URL 默认使用 'https://app.hex.tech/api/v1'，如有需要可以使用 '--api-url' 参数指定。
- 使用环境变量: 设置 'HEX_API_KEY' 和 'HEX_API_URL' 环境变量。
启动 MCP 服务器: 当 MCP 客户端（如 Cursor）需要连接 Hex MCP Server 时，会自动根据 '.cursor/mcp.json' 中的配置启动服务器。你也可以手动运行 'hex-mcp run' 命令启动服务器。
在 MCP 客户端中使用: 在 Cursor 等 MCP 客户端中，你可以发起 AI 对话，并指示 AI 使用 "hex-mcp" 服务器提供的工具来操作 Hex 项目。例如，你可以要求 AI “列出我的 Hex 项目” 或 “运行 ID 为 [project_id] 的项目”。

关键词