使用说明
MCP桥API
HTTP API桥,通过REST端点将TypeingMind插件连接到MCP服务器(Google Ads、Meta Ads)。
设置
- 安装依赖项:
npm install
-
配置环境变量:
- 复制
.env.example到.env - 更新
MCP_SERVER_URL使用您的实际MCP服务器URL - 根据需要调整其他设置
- 复制
-
启动服务器:
# Production
npm start
# Development (with auto-reload)
npm run dev
配置
环境变量(在中配置 .env):
PORT-服务器端口(默认值:3000)MCP_SERVER_URL-MCP服务器的URL(必填)CORS_ORIGIN-允许的CORS源(使用*全部,或逗号分隔的列表)API_KEY-用于身份验证的API密钥(生产所需,生成安全随机字符串)
认证
所有API端点(除 /health)要求使用API密钥进行身份验证。
如何进行身份验证:
通过以下方式之一包含API密钥:
选项1:X-API-Key集管
curl -H "X-API-Key: your-api-key-here" http://localhost:3000/api/tools
选项2:授权承载令牌
curl -H "Authorization: Bearer your-api-key-here" http://localhost:3000/api/tools
正在生成安全的API密钥:
您可以使用以下方法生成安全的随机API密钥:
# Node.js
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"
# OpenSSL
openssl rand -hex 32
# Or any password manager's random string generator
API终点
健康检查
GET /health
返回服务器状态和MCP连接状态。 无需身份验证。
列出可用工具
GET /api/tools
X-API-Key: your-api-key-here
返回所有可用的MCP工具及其定义。
列出Google广告帐户
GET /api/google-ads/accounts
X-API-Key: your-api-key-here
返回可访问的Google Ads帐户。
执行GAQL查询
POST /api/google-ads/execute-gaql
Content-Type: application/json
X-API-Key: your-api-key-here
{
"query": "SELECT campaign.id, campaign.name FROM campaign",
"customer_id": "1234567890",
"login_customer_id": "9876543210" // optional
}
执行Google广告查询语言查询。
获取GAQL文档
GET /api/google-ads/gaql-doc
X-API-Key: your-api-key-here
返回GAQL文档。
获取报告视图文档
GET /api/google-ads/reporting-view-doc?view=campaign
X-API-Key: your-api-key-here
返回特定报告视图的文档(可选 view 参数)。
发展
- 跑
npm run dev使用nodemon自动重新加载启动服务器 - 当您更改代码时,服务器将自动重新启动
需求
- Node.js v16或更高版本
- 使用SSE传输的正在运行的MCP服务器
跑步前
重要:您必须更新 MCP_SERVER_URL 在你的 .env 在启动应用程序之前,使用有效的MCP服务器URL创建文件。占位符URL将不起作用。
