icon for mcp server

APIG

STDIO

MCP server for Volcengine APIG gateway management with natural language cloud resource operations

APIG MCP Server

APIG MCP Server 是一个模型上下文协议(Model Context Protocol)服务器，为MCP客户端(如Claude Desktop)提供与火山引擎APIG服务交互的能力。可以基于自然语言对云端实例资源进行全链路管理，支持实例、服务、路由的查询操作，实现APIG资源的高效管理。

版本v0.2.0
描述基于 MCP 管理 APIG 资源，智能化流量管理
分类容器与中间件
标签API网关 AI网关

Tools

本 MCP Server 产品提供以下 Tools (工具/能力):

Tool 1: list_gateways

类型

SaaS

详细描述

该工具允许您便捷查看火山引擎APIG的实例列表。

调试所需的输入参数:

输入：

{
  "inputSchema": {
    "type": "object",
    "properties": {
      "region": {
        "description": "区域，默认为 cn-beijing",
        "type": "string"
      }
    },
    "required": []
  },
  "name": "list_gateways",
  "description": "查询您账号下拥有的所有网关实例的列表。"
}

输出：

  • 返回您账号下拥有的网关实例列表，包含实例名称、实例ID、创建时间等信息。

最容易被唤起的 Prompt示例

列举火山引擎 APIG 的实例列表。

Tool 2: get_gateway

类型

SaaS

详细描述

该工具允许您便捷查看火山引擎APIG的实例详情。

调试所需的输入参数:

输入：

{
  "inputSchema": {
    "type": "object",
    "properties": {
       "id": {
         "description": "The ID of the gateway instance to query.",
         "type": "string"
       },
      "region": {
        "description": "区域，默认为 cn-beijing",
        "type": "string"
      }
    },
    "required": [
      "id"
    ]
  },
  "name": "get_gateway",
  "description": "查询您账号下拥有的网关实例的详情。"
}

输出：

  • 返回您账号下拥有的网关实例详情，包含实例名称、实例ID、创建时间等信息。

最容易被唤起的 Prompt示例

查询火山引擎 APIG 的实例详情。

Tool 3: create_serverless_gateway

类型

SaaS

详细描述

该工具允许您便捷创建火山引擎APIG实例。

调试所需的输入参数:

输入：

{
  "inputSchema": {
    "type": "object",
    "properties": {
       "name": {
           "description": "The name of the gateway instance to create, if not provided, a random name will be generated.",
           "type": "string"
       },
      "region": {
        "description": "区域，默认为 cn-beijing",
        "type": "string"
      }
    },
    "required": [
    ]
  },
  "name": "create_serverless_gateway",
  "description": "创建 serverless 网关实例"
}

输出：

  • 返回您账号下创建的网关实例 ID。

最容易被唤起的 Prompt 示例

创建火山引擎 APIG 网关实例。

Tool 4: list_gateway_services

类型

SaaS

详细描述

该工具允许您便捷查看火山引擎APIG的实例下的服务列表。

调试所需的输入参数:

输入：

{
  "inputSchema": {
    "type": "object",
    "properties": {
      "gateway_id": {
         "description": "The id of the gateway instance to query.",
         "type": "string"
       },
      "region": {
        "description": "区域，默认为 cn-beijing",
        "type": "string"
      }
    },
    "required": [
      "gateway_id"
    ]
  },
  "name": "list_gateway_services",
  "description": "查询您账号下拥有的网关实例的服务列表。"
}

输出：

  • 返回您账号下拥有的网关实例下的服务列表，包含服务名称、服务ID、域名、创建时间等信息。

最容易被唤起的 Prompt 示例

列举火山引擎 APIG 的服务列表。

Tool 5: get_gateway_service

类型

SaaS

详细描述

该工具允许您便捷查看火山引擎APIG的服务详情。

调试所需的输入参数:

输入：

{
  "inputSchema": {
    "type": "object",
    "properties": {
       "id": {
         "description": "The id of the gateway service to query.",
         "type": "string"
       },
      "region": {
        "description": "区域，默认为 cn-beijing",
        "type": "string"
      }
    },
    "required": [
      "id"
    ]
  },
  "name": "get_gateway_service",
  "description": "查询您账号下拥有的网关服务详情。"
}

输出：

  • 返回您账号下拥有的网关服务详情，包含服务名称、实例ID、域名、创建时间等信息。

最容易被唤起的 Prompt示例

查询火山引擎 APIG 的服务详情。

Tool 6: create_gateway_service

类型

SaaS

详细描述

该工具允许您便捷创建火山引擎APIG服务。

调试所需的输入参数:

输入：

{
  "inputSchema": {
    "type": "object",
    "properties": {
      "gateway_id": {
         "description": "The id of the gateway instance to create the service.",
         "type": "string"
       },
       "name": {
           "description": "The name of the gateway service to create, if not provided, a random name will be generated.",
           "type": "string"
       },
      "region": {
        "description": "区域，默认为 cn-beijing",
        "type": "string"
      }
    },
    "required": [
      "gateway_id"
    ]
  },
  "name": "create_gateway_service",
  "description": "创建网关服务"
}

输出：

  • 返回您账号下创建的网关服务 ID。

最容易被唤起的 Prompt 示例

创建火山引擎 APIG 网关服务。

Tool 7: list_gateway_routes

类型

SaaS

详细描述

该工具允许您便捷查看火山引擎APIG的实例下的路由列表。

调试所需的输入参数:

输入：

{
  "inputSchema": {
    "type": "object",
    "properties": {
      "gateway_id": {
         "description": "The id of the gateway instance to query.",
         "type": "string"
       },
      "region": {
        "description": "区域，默认为 cn-beijing",
        "type": "string"
      }
    },
    "required": [
      "gateway_id"
    ]
  },
  "name": "list_gateway_routes",
  "description": "查询您账号下拥有的网关实例的路由列表。"
}

输出：

  • 返回您账号下拥有的网关实例下的路由列表，包含路由名称、路由ID、域名、创建时间等信息。

最容易被唤起的 Prompt 示例

列举火山引擎 APIG 的路由列表。

Tool 8: get_gateway_route

类型

SaaS

详细描述

该工具允许您便捷查看火山引擎APIG的路由详情。

调试所需的输入参数:

输入：

{
  "inputSchema": {
    "type": "object",
    "properties": {
       "id": {
         "description": "The id of the gateway route to query.",
         "type": "string"
       },
      "region": {
        "description": "区域，默认为 cn-beijing",
        "type": "string"
      }
    },
    "required": [
      "id"
    ]
  },
  "name": "get_gateway_route",
  "description": "查询您账号下拥有的网关路由详情。"
}

输出：

  • 返回您账号下拥有的网关路由详情，包含路由名称、路由ID、域名、创建时间等信息。

最容易被唤起的 Prompt 示例

查询火山引擎 APIG 的路由详情。

可适配平台

方舟，python，cursor

服务开通链接 (整体产品)

https://console.volcengine.com/veapig

鉴权方式

火山引擎，从 volcengine 管理控制台获取 volcengine 访问密钥 ID、秘密访问密钥和区域，请在.env文件中设置相关环境变量

环境变量

以下环境变量可用于配置MCP服务器:

环境变量描述默认值
VOLCENGINE_ACCESS_KEY火山引擎账号 ACCESS KEY-
VOLCENGINE_SECRET_KEY火山引擎账号 SECRET KEY-
VOLCENGINE_REGION火山引擎 APIG region-
VOLCENGINE_ENDPOINTVolcengine endpoint-
MCP_SERVER_PORTMCP server listening port8000

安装部署

系统依赖

  • 安装 Python 3.10 或者更高版本
  • 安装 uv
    • 如果是linux系统
    curl -LsSf https://astral.sh/uv/install.sh | sh
    • 如果是window系统
    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
  • 同步依赖项并更uv.lock: 
    uv sync
  • 构建mcp server: 
    uv build

Using uv (recommended)

When using uv no specific installation is needed. We will use uvx to directly run mcp-server-veapig.

本地配置

添加以下配置到你的 mcp settings 文件中

{
  "mcpServers": {
    "mcp-server-veapig": {
      "command": "uv",
      "args": [
        "--directory",
        "/ABSOLUTE/PATH/TO/PARENT/FOLDER/src/mcp_server_veapig",
        "run",
        "mcp-server-veapig"
      ]
    }
  }
}

在不同平台的配置

方舟

体验中心

[示例如下]

  1. 查看MCP Server 详情 在大模型生态广场，选择合适的MCP Server，并查看详情
  2. 选择MCP Server即将运行的平台 检查当前MCP Server 已适配的平台，并选择合适的平台
  3. 查看并对比可用的Tools 仔细查看可用的Tools的功能描述与所需的输入参数，并尝试运行对应的功能。
  4. 获取专属的URL或代码示例 检查账号登录状态与服务开通情况，生成唯一URL
  5. 去对应的Client的平台进行使用 点击快捷跳转按钮，前往方舟平台的体验中心进行对应MCP Server的体验

产品截图/视频 - optional

Cursor

部署

[示例如下]

UVX

{
  "mcpServers": {
    "mcp-server-veapig": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/volcengine/mcp-server#subdirectory=server/mcp_server_veapig",
        "mcp-server-veapig"
      ],
      "env": {
        "VOLCENGINE_ACCESS_KEY": "your access-key-id",
        "VOLCENGINE_SECRET_KEY": "your access-key-secret"
      }
    }
  }
}

License

volcengine/mcp-server is licensed under the MIT License.

Be the First to Experience MCP Now