@anchrd/colab-sdk (英语)
Colab的合约: TypeScript类型和Zod chemas 对于Colab之间跨越的一切 UI,它的后端和外部服务,客户端一个外部服务使用一个Colab 装置 一个人是谁和他们可以做什么.
它没有服务器框架,也没有读取环境;它唯一的依赖性是 zod 财务报告和审定财务报表
ulid一起释放 @anchrd/colab 在同一版本编号下:
@anchrd/colab-sdk 其版本等于 @anchrd/colab 您的安装运行.
安装
npm install @anchrd/colab-sdk
只有ES模块,有类型声明.
出口的东西
- 示马及其种类,每个名称,用于输入和回答 Colab 的 API 工具
(原始内容存档于2018-09-29). and MCP. 一个计划以其工具命名:
access_invitation_create带InvitationCreateInput, (中文(简体) ),access_user_list带UserListInput。计划将在运行时验证 (单位:千美元)UserListInput.parse(body)),同名类型描述解析值. - 日记数字 :
idSchema(resource)只接受该资源中的一个 id (user_01J…, (中文(简体) ),node_01J…),以及createId(resource)做一个. - 错误形状
ErrorResponse数字 :{ error: { code, message } },与code一个not_found, (中文(简体) ),invalid, (中文(简体) ),conflict, (中文(简体) ),unauthenticated财务报告和审定财务报表unavailable(单位:千美元)errorCodes) (中文(简体) ). - 命名语法每一个能力都有一个三部分的名称,
package · resource · action, (中文(简体) ), 财务报告和审定财务报表toolRoute, (中文(简体) ),toolPermission财务报告和审定财务报表toolEvent获取其路线、右和协议事件. createServiceClient,外部服务的客户.
服务客户端
注册的服务 设置 QQ 服务 持有服务密钥。 用它,服务检查
每一个请求都给打电话的代号 并在当地决定他们可以叫什么 Colab只接受一个
它为此项服务(为操作员的,或为服务OAuth资源的人的); a
科拉布会议和科拉布的代币 /mcp 起来 401数字 :
import { createServiceClient } from "@anchrd/colab-sdk";
const colab = createServiceClient({
url: "https://<customer>.anchrd.sh",
serviceKey: process.env.COLAB_SERVICE_KEY,
});
// Declare the service's interfaces once; they become rights under Settings › Roles.
await colab.interfaces.set("reports", ["read", "export"]);
// Once per request, with the person's token.
const answer = await colab.authorize(token);
if (answer.ok && answer.can("reports", "export")) {
// answer.identity names the person or machine
}
can() 决定回来的规则 不再打电话 每一次失败都是因为
ok: false, (中文(简体) ), status 财务报告和审定财务报表 error绝不犯错误,每一次答覆
以上计相. 客户端使用标准 fetch因此,它运行在工人,节点,邦和
浏览器; fetch 财务报告和审定财务报表 timeoutMs 可以传入.
服务密钥是一个秘密:它只在 authorization 头曰. 远离记录
答对.
许可证
失败.