
如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具,协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题,请先让 AI 阅读并遵守轩辕镜像的规则文档。
只需在 AI 对话中先发送下面这句话即可:
请先完整阅读并严格遵守以下文档中的全部规则与要求:
https://xuanyuan.cloud/agents.md
在未充分阅读并理解该文档前,不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。查看 agents.md 用法指南与完整示范。国内用户首推 元宝 AI、DeepSeek 的深度思考模式,不推荐豆包 AI;Cursor 等编辑器可在对话 @ 该链接,或加入 User Rules。 若 AI 无法访问外链,可 打开说明文档 复制全文粘贴。文档会随站点更新,复制内容可能过期,建议定期检查。
这是一个独立代理工具,可将任何由OpenAPI/Swagger描述的HTTP API转换为**MCP(模型上下文协议)**服务器。它在启动时加载规范,通过包含/排除规则过滤API操作,并为每个操作注册一个MCP工具,工具调用会作为HTTP请求转发至后端API。
适用于已有(或计划构建)带OpenAPI/Swagger规范的REST API场景:同一规范既可驱动人类可读的API文档,也能为AI客户端提供MCP工具。
MCP_OPENAPI_SPEC_URL(优先)或MCP_OPENAPI_SPEC_FILE加载OpenAPI规范;MCP_INCLUDE_ENDPOINTS则仅保留指定操作,否则排除MCP_EXCLUDE_ENDPOINTS中的操作(包含规则优先级更高);MCP_TOOL_PREFIX+路径段(如api_+messages→api_messages),输入 schema 来自参数和请求体(Zod),处理器为向MCP_API_BASE_URL发起HTTP请求。传输方式:流HTTP;端点:POST /mcp 和 GET /mcp。
| 变量名 | 描述 | 默认值 |
|---|---|---|
MCP_API_BASE_URL | API请求的基础URL | http://127.0.0.1:3000 |
MCP_OPENAPI_SPEC_URL | OpenAPI规范的URL(如http://api:3000/openapi.json),优先级高于文件 | - |
MCP_OPENAPI_SPEC_FILE | OpenAPI JSON文件路径(URL未设置时使用) | - |
MCP_INCLUDE_ENDPOINTS | 逗号分隔的method:path列表(如get:/messages,get:/channels),仅指定操作转为工具 | - |
MCP_EXCLUDE_ENDPOINTS | 逗号分隔的method:path列表,需排除的操作(包含列表中的操作不受影响) | - |
MCP_TOOL_PREFIX | 工具名称前缀(如api_→api_messages) | 空 |
MCP_SERVER_NAME | 向MCP客户端报告的服务器名称 | openapi-to-mcp |
MCP_PORT | 流HTTP服务器端口 | 3100 |
MCP_HOST | 绑定主机 | 0.0.0.0 |
注意:必须设置MCP_OPENAPI_SPEC_URL或MCP_OPENAPI_SPEC_FILE中的至少一个。
bashdocker run --rm -p 3100:3100 \ -e MCP_OPENAPI_SPEC_URL=http://host.docker.internal:3000/openapi.json \ -e MCP_API_BASE_URL=http://host.docker.internal:3000 \ evilfreelancer/openapi-to-mcp:latest
Linux环境可能需添加--add-host=host.docker.internal:host-gateway或使用主机网络。
bashdocker run --rm -p 3100:3100 \ -v $(pwd)/openapi.json:/app/openapi.json:ro \ -e MCP_OPENAPI_SPEC_FILE=/app/openapi.json \ -e MCP_API_BASE_URL=http://host.docker.internal:3000 \ evilfreelancer/openapi-to-mcp:latest
.env.example为.env并设置MCP_OPENAPI_SPEC_URL和MCP_API_BASE_URL;bashdocker compose up -d
MCP服务器将在http://localhost:3100/mcp可用(流HTTP)。
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本,请访问 标签列表页面。
来自真实用户的反馈,见证轩辕镜像的优质服务