@coda-console/plugin-check 0.5.5 → 0.5.6

package/check/coda/components/plugins/model-protocols.mjs

@@ -1,35 +1,38 @@
 // The interfaces a model service may speak (docs/plugins.md「模型服务」): a closed table. A plugin providing a service names
-// one of these (`api`), and so does one choosing services by what it speaks (`modelApis`); the node delivers a service with
-// its key where its interface carries it (model-services.mjs), Coda lists its models as a client of it would
-// (model-check.mjs), and what an agent is told of using one comes from here (coda-resources explain). A new interface is a
-// row here: the node would not know where its key goes otherwise.
-// Each: its name and where it is defined; how its clients send a key (`key`) and what else (`also`); how the node hands
-// a key on to the service (`delivered`); how it is called at a base address (`call`), and an example there.
-// Anthropic's clients take the API's root and add `/v1` themselves; a service whose address is its versioned base has it
-// already.
-const messages = base => /\/v1\/?$/.test(base) ? `${base.replace(/\/$/, '')}/messages` : `${base}/v1/messages`;
+// one of these (`api`), and so does one choosing services by what it speaks (`modelApis`). Each is a kind of resource of its
+// own (model-services.mjs): a service speaking OpenAI's is nothing like one speaking Anthropic's, whoever provides them. The
+// node delivers a service with its key where its interface carries it (model-services.mjs), Coda lists its models as a
+// client of it would (model-check.mjs), and what an agent is told of calling one is its kind's definition, from here
+// (coda-resources explain). A new interface is a row here: the node would not know where its key goes otherwise.
+// Each: what it is called and where it is defined; how its clients send a key (`key`) and what else (`also`); how the node
+// hands a key on to the service (`delivered`); how it is called and an example, templates of `{base}` (the service's
+// address), `{v1}` (that with `/v1` once: Anthropic's clients take the API's root and add `/v1` themselves, and a service
+// whose address is its versioned base has it already) and `{model}`.
 export const MODEL_PROTOCOLS = {
   'openai-completions': {
-    title: 'OpenAI Chat Completions', spec: 'https://platform.openai.com/docs/api-reference/chat',
+    title: 'OpenAI Chat', spec: 'https://platform.openai.com/docs/api-reference/chat',
+    description: '讲 OpenAI Chat Completions 接口的服务',
     key: key => ({ Authorization: `Bearer ${key}` }), also: {},
     delivered: key => ({ authorization: `Bearer ${key}` }),
-    call: base => `POST ${base}/chat/completions，body 带 model 与 messages`,
-    example: (base, model) => `curl -s ${base}/chat/completions -H 'Authorization: Bearer coda' -H 'Content-Type: application/json' \\\n  -d '{"model": "${model}", "messages": [{"role": "user", "content": "你好"}]}'`,
+    call: 'POST {base}/chat/completions，body 带 model 与 messages',
+    example: `curl -s {base}/chat/completions -H 'Authorization: Bearer coda' -H 'Content-Type: application/json' \\\n  -d '{"model": "{model}", "messages": [{"role": "user", "content": "你好"}]}'`,
   },
   'openai-responses': {
     title: 'OpenAI Responses', spec: 'https://platform.openai.com/docs/api-reference/responses',
+    description: '讲 OpenAI Responses 接口的服务',
     key: key => ({ Authorization: `Bearer ${key}` }), also: {},
     delivered: key => ({ authorization: `Bearer ${key}` }),
-    call: base => `POST ${base}/responses，body 带 model 与 input`,
-    example: (base, model) => `curl -s ${base}/responses -H 'Authorization: Bearer coda' -H 'Content-Type: application/json' \\\n  -d '{"model": "${model}", "input": "你好"}'`,
+    call: 'POST {base}/responses，body 带 model 与 input',
+    example: `curl -s {base}/responses -H 'Authorization: Bearer coda' -H 'Content-Type: application/json' \\\n  -d '{"model": "{model}", "input": "你好"}'`,
   },
   'anthropic-messages': {
-    title: 'Anthropic Messages', spec: 'https://docs.anthropic.com/en/api/messages',
+    title: 'Anthropic', spec: 'https://docs.anthropic.com/en/api/messages',
+    description: '讲 Anthropic Messages 接口的服务',
     key: key => ({ 'x-api-key': key }), also: { 'anthropic-version': '2023-06-01' },
     // Some of its clients send the key as a bearer token: the node sends it both ways.
     delivered: key => ({ 'x-api-key': key, authorization: `Bearer ${key}` }),
-    call: base => `POST ${messages(base)}，body 带 model、max_tokens 与 messages；带请求头 anthropic-version`,
-    example: (base, model) => `curl -s ${messages(base)} -H 'x-api-key: coda' -H 'anthropic-version: 2023-06-01' -H 'Content-Type: application/json' \\\n  -d '{"model": "${model}", "max_tokens": 256, "messages": [{"role": "user", "content": "你好"}]}'`,
+    call: 'POST {v1}/messages，body 带 model、max_tokens 与 messages；带请求头 anthropic-version',
+    example: `curl -s {v1}/messages -H 'x-api-key: coda' -H 'anthropic-version: 2023-06-01' -H 'Content-Type: application/json' \\\n  -d '{"model": "{model}", "max_tokens": 256, "messages": [{"role": "user", "content": "你好"}]}'`,
   },
 };
 export const MODEL_APIS = Object.keys(MODEL_PROTOCOLS);

package/check/coda/contract.json

@@ -1,5 +1,5 @@
 {
-  "commit": "95e6604b90218e38e5730725dcf57c8efddf8c10",
+  "commit": "93e1f9059276267bbf0aa4cd2979a98e199b6547",
   "packages": {
     "@0dep/piso": "5.2.0",
     "@agentclientprotocol/sdk": "1.4.0",
@@ -7,7 +7,7 @@
   },
   "files": {
     "check/coda/components/plugins/agent-plugins.mjs": "23016dd0f7350a10f71565a2c44e2c1179299a93e8c859529071099f2ce862d1",
-    "check/coda/components/plugins/model-protocols.mjs": "e02e056a002f0a6c8a5accb39a52635558fa7141540e475f79a309278acb015b",
+    "check/coda/components/plugins/model-protocols.mjs": "762244c01266cf61384377bdfbb84bef5ab157b1783f9254ddc1ae3d576a73c5",
     "check/coda/components/plugins/plugin-extensions.mjs": "e527800a109ec9849975357f841b0c05ecfa50c9d9c34e26d828aef3cb7d3cb3",
     "check/coda/components/plugins/plugin-rules.mjs": "78d9431c1b4f6354457f153bb74a0fd085c771eaadd9f7523633915cb700f4f9",
     "check/coda/components/plugins/plugin-source-rules.mjs": "d620ee62fb372e31e5389e27f7202308aab74324b6f5552ffef3844afc7d0001",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coda-console/plugin-check",
-  "version": "0.5.5",
+  "version": "0.5.6",
   "description": "Coda 插件的契约检查：扮演 Coda 读清单、启动 Agent 讲 ACP 与 _coda/wait、读面板。",
   "license": "MIT",
   "repository": {