Back to MCP directory
publicPublicdnsLocal runtime

hex-mcp

Hex平台的MCP服务工具,提供项目管理和运行控制功能

article

README

🚀 Hex-MCP 服务器

Hex-MCP 服务器是为 Hex 专门实现的 MCP 服务器,它提供了一系列实用工具,可帮助用户方便地管理和操作 Hex 项目,如列出项目、搜索项目、获取项目详情等。

🚀 快速开始

Hex-MCP 服务器支持多种工具,为你管理 Hex 项目提供便利:

  • list_hex_projects:列出可用的 Hex 项目
  • search_hex_projects:按模式搜索 Hex 项目
  • get_hex_project:获取特定项目的详细信息
  • get_hex_run_status:检查项目运行状态
  • get_hex_project_runs:获取项目的运行历史记录
  • run_hex_project:执行一个 Hex 项目
  • cancel_hex_run:取消正在运行的项目

📦 安装指南

使用 uv 是推荐的安装方式:

uv add hex-mcp

或者使用 pip:

pip install hex-mcp

确认是否正常工作的命令:

hex-mcp --version

📚 详细文档

配置

使用 config 命令(推荐)

通过 config 命令配置 hex-mcp,传递你的 API 密钥和 API URL(可选,默认为 https://app.hex.tech/api/v1):

hex-mcp config --api-key "your_hex_api_key" --api-url "https://app.hex.tech/api/v1"

⚠️ 重要提示

这会将配置保存到你用户目录中的文件(例如 ~/.hex-mcp/config.yml),使其在所有 hex-mcp 调用中可用。

使用环境变量

或者,Hex MCP 服务器也可以通过环境变量进行配置:

  • HEX_API_KEY:你的 Hex API 密钥
  • HEX_API_URL:Hex API 的基础 URL

当为 Cursor 设置 MCP 服务器的环境变量时,它们需要全局有效,或使用 uv 的 --env-file 标志在调用服务器时传递。

与 Cursor 使用

Cursor 允许 AI 代理通过 MCP 协议与 Hex 交互。按照以下步骤设置并使用 hex-mcp 与 Cursor 配合:

基础用法

在项目根目录中创建一个 .cursor/mcp.json 文件,内容如下:

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

高级用法

或者,如果你的 PATH 中包含 hex-mcp 命令,可以直接使用:

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

一旦运行起来,你可以在 Cursor 中通过启动新的 AI(代理)对话并要求其列出或运行 Hex 项目来使用它。

⚠️ 重要提示

MCP 服务器和 CLI 仍在开发中,可能会有破坏性更改。

help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client