集成与 API
公共 API 和 MCP 服务是可选的,当您希望外部集成或 AI 客户端访问您的部署时,可以公开它们。
两者在撰写文件中都是单独的服务,因此您可以稍后添加其中之一,而无需触摸应用程序。参见 服务与路由 域和端口。
公共API
公共 API 服务用于集成、webhook 和 API 文档。
当公开时,API 参考可在以下位置获得:
| 路径 | 使用 |
|---|---|
/docs | 交互式标量参考。 |
/swagger | Swagger UI 参考。 |
/openapi.json | 用于 SDK 生成的 OpenAPI 文档。 |
/webhook-event-types | 当前列表中此部署可以发送的 webhook 事件类型。 |
例如:
https://api.kanera.example.com/docs
https://api.kanera.example.com/webhook-event-types
海 API 用于 API 密钥、首次请求、webhook 和签名验证。
MCP
MCP 服务允许 AI 客户端通过 Streamable HTTP 连接到 Kanera。
暴露时,终点为:
https://mcp.kanera.example.com/mcp
该 /health Kanera 向用户显示确切的 MCP 地址,以便在其 AI 客户端的控制下, 配置文件设置 -> API 密钥,所以将人们指向那里,而不是要求他们组装 URL。
设置公开 MCP URL 时:
MCP_SERVER_PUBLIC_URL=https://mcp.kanera.example.com/mcp
在 Docker Compose 中,将内部 MCP-to-public-API URL 保持为:
KANERA_PUBLIC_API_URL=http://public-api:3001
MCP 客户端使用 Kanera API 密钥进行身份验证,方法如下:
Authorization: Bearer kanera_live_...
使用来自 配置文件设置 -> API 密钥 用户自己的 AI 客户端在其无障碍板中使用工作区键 工作区设置 -> API 用于共享 MCP 客户端或固定到一个工作区的服务器端自动化。
面向 AI 代理的 OAuth
若要让兼容的代理通过浏览器登录而不是 API 密钥连接,请为 Kanera 配置其公共 OAuth URL。将公共 API 的颁发者设置在 public-api 服务:
PUBLIC_API_OAUTH_ISSUER=https://api.kanera.example.com
为私有 MCP 到公共 API 令牌交换生成单独的秘密:
MCP_INTERNAL_SECRET=<output of openssl rand -hex 32>
值必须至少为32个字符,必须不同于 JWT_SECRET,并且必须相同 public-api 以及 mcp 捆绑的 Compose 文件将其传递给这两个服务。
MCP_SERVER_PUBLIC_URL (上面设置)驱动 MCP 受保护资源元数据。与捆绑的 docker-compose.yml,另外两个变量会自动导出: MCP_PUBLIC_URL (向用户显示的规范 OAuth 资源和 MCP 地址)来自 MCP_SERVER_PUBLIC_URL,以及 MCP 服务的 OAUTH_ISSUER_URL 从 PUBLIC_API_OAUTH_ISSUER.
OAuth 授权和令牌请求将每个代码、授权、刷新系列和访问令牌绑定到该规范 MCP_PUBLIC_URL。原料 kanera_mcp_... 只能在 MCP 端点上工作,并且被拒绝 /api/v1; MCP 服务在内部将它们交换为单独的短暂授权凭证。
将 OAuth 发现路径路由到您的反向代理上的正确服务:
| 路径 | 服务 |
|---|---|
/.well-known/oauth-authorization-server, /oauth/* | public-api |
/.well-known/oauth-protected-resource, /.well-known/oauth-protected-resource/mcp, /mcp | mcp |
从发布了 OAuth 令牌但未绑定资源的版本升级时,迁移会撤销现有的 OAuth 授权和令牌。 已注册的客户端定义保留,但用户和无人值守代理必须在该旧版迁移后重新连接一次。 读/写策略更新不会撤销有效的 OAuth 会话,因此不需要重新连接。
海 连接 AI 代理 对于全流,以及 将 Kanera 连接到您的 AI 代理 用于客户端设置和 MCP 功能。
Trello 导入附件复制
Trello 板 JSON 导入工作,无需额外设置。
要让用户将 Trello 文件附件导入到 Kanera,请配置 Trello API 密钥:
TRELLO_API_KEY=your-trello-api-key
从 Trello 的 Power-Up 管理页面创建密钥 https://trello.com/power-ups/admin。无需 Power-Up 功能; Power-Up/app 条目只是 API 密钥的 Trello 容器。用户在导入期间连接 Trello,以便 Kanera 可以复制该导入的附件。
海 从 Trello 导入.
