首页 / 接入文档
Documentation
从工具发现到接入规划
了解目录字段、接入方式和建议的 API 结构。本文档是产品原型说明,代码与地址为占位示例,不会连接真实服务。
当前阶段:公开工具目录和详情可在本地预览。身份认证、MCP 服务、CLI 与执行 API 尚未上线;请勿把示例密钥或请求地址用于生产调用。
01 · Overview
概览与推荐流程
OPC AgentHub 的目标是让 Agent 在统一目录中发现工具,读取参数定义,再通过标准执行入口提交任务。实际可用能力、身份规则和计费方法需要以正式上线版本为准。
- 在工具市场按分类、标签或关键词查找能力。
- 打开详情,确认用途、参数 Schema、状态与实际计价规则。
- 在服务端保存身份凭证,按经批准的接入方式调用。
- 记录请求标识、执行状态与最终使用量,处理失败与重试。
当前目录数据是公开信息研究快照。它不能证明某个供应商当前可用,也不能代替正式价格表或授权说明。
02 · Connect
接入方式
产品规划覆盖 HTTP、MCP 与命令行三种工作流。下面示例统一使用保留域名 .example 和占位 API Key。
HTTP API 规划示例
适合由服务端封装调用,并在自有系统内处理身份、权限和日志。
curl --request POST --url 'https://api.opc-agenthub.example/api/v1/executions' --header 'Authorization: Bearer YOUR_API_KEY' --header 'Content-Type: application/json' --data '{"tool_id":"9504","input":{"ts_code":"600519.SH"}}'MCP 规划示例
适合支持 MCP 的 Agent Host。上线后由管理员配置实际服务地址和密钥。
{"mcpServers":{"opc-agenthub":{"type":"http","url":"https://api.opc-agenthub.example/mcp","headers":{"Authorization":"Bearer YOUR_API_KEY"}}}}命令行 尚未发布
未来 CLI 计划提供账户、工具发现、详情查询和调用命令。下面是期望的命令形态,不是已发布的软件包。
opc-agenthub tools list --query "daily quote" && opc-agenthub tools get 9504 && opc-agenthub tools run 9504 --input input.json
03 · API reference
工具 API 规划
以下路径沿用项目设计方案中的统一 /api/v1 约定。当前没有对应后端服务。
| 方法 | 路径 | 说明 |
|---|---|---|
| GET | /tools | 分类、关键词筛选与分页查询 |
| GET | /tools/:id | 读取工具详情与参数 Schema |
| POST | /recommendations | 根据任务描述返回候选工具 |
| POST | /executions | 校验参数并创建执行任务 |
| GET | /executions/:id | 查询执行状态与结果 |
建议的请求体
{"tool_id":"9504","input":{"ts_code":"600519.SH"},"request_id":"client-generated-id"}正式实现还需要定义分页字段、错误码、超时、异步状态、幂等规则和计费事件。接口只有在服务端实际部署并完成验证后才可使用。
04 · Safety
安全与错误处理
- 将真实密钥放在服务端密钥存储中,不要写进网页、代码仓库或浏览器日志。
- 执行前校验工具状态、输入 Schema、组织权限和额度。
- 使用请求标识追踪失败;只有幂等且供应商支持的动作才可安全重试。
- 浏览器跳转或关闭页面不等于取消远程任务。
错误码与认证策略仍需随真实后端一起定义。此处说明的是规划原则,不构成当前服务 SLA。