腾讯电子签 ESS MCP Server
基于 MCP (Model Context Protocol) 的腾讯电子签 API 服务网关，将腾讯电子签 API 接口注册为 MCP 工具，供大模型调用。
编译
环境要求
编译步骤
git clone https://github.com/tencentess/ess_mcp_server
cd ess_mcp_server
go mod tidy
go build
编译完成后会在当前目录生成 ess_mcp_server 可执行文件。
部署结构
├── ess_mcp_server # 可执行文件
├── config.yaml # 配置文件
└── yaml/ # Swagger API 定义文件目录
├── ess_1.yaml
└── ess_2.yaml
程序启动时会自动读取 可执行文件同目录下 的 config.yaml 和 yaml/ 文件夹下的 API 定义文件。
配置说明 (config.yaml)
完整配置示例
server:
# MCP Server 对外可访问的 IP 或域名（不含协议和端口）
# 用于文件上传服务地址的组合，默认值为 localhost
server_ip: "localhost"
# MCP Server 监听端口（默认 8080）
port: "8080"
# MCP Server 名称
name: "腾讯电子签 ESS MCP Server"
# MCP Server 版本
version: "1.0.0"
# 是否开启 debug 模式（开启后会打印请求参数、响应内容等详细日志）
debug: true
schema:
# 工具列表中精简描述的最大长度（默认 300）
desc_max_len_short: 300
# 接口详情描述的最大长度（默认 1000）
desc_max_len_long: 1000
# 每个参数描述的最大长度（默认 1000）
desc_max_len_medium: 1000
# 参数详细说明最大递归深度（默认 4，太深会导致 mcp client too large 报错）
schema_max_detail_depth: 4
# 默认凭证配置（可通过 MCP Client HTTP Headers 覆盖）
credentials:
# 腾讯云 SecretId
secret_id: "你的 SecretId"
# 腾讯云 SecretKey
secret_key: "你的 SecretKey"
# 环境（可选值: test / online）
env: "test"
# 默认操作人 UserId
# 如果配置了此项，API 调用时会自动注入到 Operator.UserId 中（不覆盖用户显式传递的值）
# 也可通过 HTTP Header X-User-Id 覆盖
user_id: ""
api:
# 腾讯云 API 服务名（ess 或 essbasic）
service: "ess"
# 腾讯云 API 版本号
api_version: "2020-11-11"
# Endpoint 配置（按环境区分）
endpoints:
test:
default: "ess.test.ess.tencent.cn"
custom:
UploadFiles: "file.test.ess.tencent.cn"
online:
default: "ess.tencentcloudapi.com"
custom:
UploadFiles: "file.ess.tencent.cn"
# API 接口白名单（只加载列表中的接口，留空则加载全部）
# 建议按需配置，API 太多会导致 token 消耗过快
loading_apis:
- DescribeFlowTemplates
- CreateFlowByFiles
- DescribeFlowInfo
# ... 按需添加
关键配置说明
| 配置项 | 说明 |
|---|---|
| server.server_ip | 服务对外可访问的 IP 或域名（不含协议和端口），用于与 port 组合生成文件上传服务地址（http://{server_ip}:{port}）。默认 localhost，部署到远程服务器时需改为实际 IP 或域名 |
| server.port | 服务监听端口，默认 8080 |
| server.debug | 开启后会在 ./log/ 目录下输出详细的请求和响应日志 |
| credentials | 默认的腾讯云凭证，当 MCP Client 未通过 HTTP Headers 传递凭证时使用 |
| credentials.user_id | 默认操作人 UserId，配置后 API 调用时自动注入到 Operator.UserId（不覆盖显式传值），也可通过 HTTP Header X-User-Id 覆盖 |
| api.service | 决定加载 yaml/ 目录下哪些 Swagger 文件（如 ess 则加载 ess_*.yaml） |
| api.loading_apis | API 白名单，建议只配置需要的接口，避免注册过多工具导致 token 超限 |
| schema.* | 控制描述文本的截断长度和参数递归深度，用于平衡准确度与 token 消耗 |
Docker 一键运行
无需安装 Go 环境，只需 Docker 即可快速启动。
1. 准备配置文件
下载或编辑项目中的 config.yaml，填入你的腾讯云凭证和所需的 API 白名单（详见上方配置说明）。
2. 启动服务
方式一：Docker Compose（推荐）
# 启动
docker compose up -d
# 查看日志
docker compose logs -f
# 停止
docker compose down
方式二：Docker Run
docker run -d --name ess-mcp-server \
-p 8080:8080 \
-v $(pwd)/config.yaml:/app/config.yaml:ro \
ccr.ccs.tencentyun.com/pulse-line-prod/ess-mcp-server:latest
启动后即可通过 http://localhost:8080/mcp 接入 MCP Client。
使用
启动服务（源码方式）
./ess_mcp_server
服务启动后会同时开启：
- MCP 服务：路径
/mcp，供大模型通过 MCP 协议调用电子签 API
- 文件上传服务：路径
/upload，用于上传合同文件（如 PDF），上传后自动生成 FileId 供后续 API 使用
MCP Client 接入
基础接入（使用 config.yaml 中的默认凭证）
{
"mcpServers": {
"ess": {
"url": "http://你部署服务的地址:8080/mcp"
}
}
}
通过 HTTP Headers 传递自定义凭证
{
"mcpServers": {
"ess": {
"url": "http://你部署服务的地址:8080/mcp",
"headers": {
"X-Secret-Id": "AK******S7BIlPZPZwx",
"X-Secret-Key": "SK********g0j",
"X-Env": "test",
"X-User-Id": "你的 UserId"
}
}
}
}
| Header | 说明 | 是否必须同时指定 |
|---|---|---|
| X-Secret-Id | 腾讯云 SecretId | 是，三者需同时指定 |
| X-Secret-Key | 腾讯云 SecretKey | 是，三者需同时指定 |
| X-Env | 环境，可选值：test / online | 是，三者需同时指定 |
| X-User-Id | 操作人 UserId，覆盖 config.yaml 中的 `crede
... View full README on GitHub
