# @reneturcios/cueport 中文文档

规范地址：https://npmcn.com/package/%40reneturcios/cueport/

版本：0\.1\.0
npm 元数据更新时间：2026-11-02T07:24:47.041Z
中文译文更新时间：2026-11-02T07:58:07.840Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40reneturcios/cueport
原文对照：https://npmcn.com/package/%40reneturcios/cueport/?lang=original
项目主页：https://github.com/CloudCorpRecords/cueport#readme
源码仓库：https://github.com/CloudCorpRecords/cueport

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：84 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2026-11-02T07:23:09.949Z
- 最新版本发布：2026-11-02T07:24:46.891Z
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

CueAPI代理——来自MCP主机或CLI的工作调度：创建、触发、暂停和更新提示，列出和声明执行，发送心跳，并报告带有证据的结果。一个bin提供一个小型CLI和一个studio MCP服务器。

## 安装

```sh
npm install @reneturcios/cueport
```

也可以使用：`pnpm add @reneturcios/cueport`、`yarn add @reneturcios/cueport`、`bun add @reneturcios/cueport`

## README

# cueport

cueport允许MCP主机或终端访问CueAPI 代理工作的协调层：调度提示(循环的cron或 一次性)，按要求解雇他们，看着他们被处决，索赔工人 执行死刑，用心跳来维持索赔，结束循环 通过报告有证据支持的结果。一个二进制服务于 命令行接口和stdio MCP服务器。

需要API密钥。集 `CUEAPI_API_KEY` 从你的 CueAPI账户;每个呼叫都发送它为 `Authorization: Bearer <key>`，并且在尝试任何请求之前丢失密钥失败。 自托管还是针对另一个主机进行测试？集 `CUEAPI_BASE_URL` 旁边的钥匙；未设置时，呼叫转到 `https://api.cueapi.ai`.

## 安装

```bash
npx @reneturcios/cueport list-cues
```

或者运行容器镜像：

```bash
docker run -i ghcr.io/cloudcorprecords/cueport
```

容器默认为MCP服务器（见下文）。通过CLI 参数将其用作CLI。

## 命令行界面

```bash
cueport create-cue --name digest --schedule "0 9 * * *" --callback-url https://example.test/hook
cueport list-cues --status active --limit 5
cueport get-cue cue_abc123
cueport fire-cue cue_abc123 --payload-override '{"topic":"release notes"}'
cueport update-cue cue_abc123 --name "morning digest"
cueport pause-cue cue_abc123
cueport resume-cue cue_abc123
cueport delete-cue cue_abc123
cueport list-executions --cue-id cue_abc123 --status failed
cueport get-execution exec_123
cueport list-claimable --task digest --agent worker-a
cueport claim-execution exec_123 --worker-id worker-7
cueport claim-next --task-name digest --worker-id worker-7
cueport heartbeat exec_123 --worker-id worker-7
cueport report-outcome exec_123 --outcome succeeded --external-id ext_42 --result-url https://example.test/result

cueport --version
```

命令打印上游JSON负载。退出代码: `0` 在 成功, `1` 当调用失败时（包括丢失API密钥或错误） 上游API错误)， `2` 使用错误。

有两种行为值得了解。暂停和恢复则不是 单独的端点：都是a `PATCH /v1/cues/{id}` 只带了一个 状态字段(`paused` 或者 `active`）. 和 `claim-next` 是扇形的， 没有单个调用：索赔端点没有任务筛选器，因此 工具首先获取服务器端过滤的可声明列表，然后选择 最老的条目，然后通过id声明执行。

## MCP服务器

一个箱子能同时满足两个人的需要。这个 `mcp` subcommand启动stdio MCP 服务器:

```bash
npx -y @reneturcios/cueport mcp
```

MCP客户端配置：

```json
{
  "mcpServers": {
    "cueport": {
      "command": "npx",
      "args": ["-y", "@reneturcios/cueport", "mcp"],
      "env": {
        "CUEAPI_API_KEY": "cue_sk_..."
      }
    }
  }
}
```

添加 `CUEAPI_BASE_URL` 到 `env` 块将服务器指向 不同的cueapi兼容主机。

### 工具

| 工具 | 输入 | 它是做什么的 |
| --- | --- | --- |
| `cueapi_create_cue` | `name`， `schedule` (需要);可选的描述、回调、方法、时区、有效负载、任务和平台字段 | 创建一个循环的或一次性的提示。 |
| `cueapi_list_cues` | `status`， `limit` (可选) | 列出线索，按状态过滤。 |
| `cueapi_get_cue` | `cue_id` | 拿一根球杆。 |
| `cueapi_fire_cue` | `cue_id`;可选 `payload_override`， `merge_strategy` （`merge` 默认情况下,或 `replace`） | 立即发出信号。 |
| `cueapi_update_cue` | `cue_id` 加上任何可变提示字段 | 稀疏的更新;只发送提供的字段。 |
| `cueapi_pause_cue` | `cue_id` | 暂停一个提示（PATCH with status） `paused`）。 |
| `cueapi_resume_cue` | `cue_id` | 恢复一个带有状态的提示（PATCH） `active`）。 |
| `cueapi_delete_cue` | `cue_id` | 永久删除提示。 |
| `cueapi_list_executions` | `cue_id`， `status`， `limit` (可选) | 按提示和状态筛选列出执行情况。 |
| `cueapi_get_execution` | `execution_id` | 获取一个带有状态和结果的执行。 |
| `cueapi_list_claimable_executions` | `task`， `agent`， `limit` (可选) | 列出未认领的工作线程执行，过滤服务器端。 |
| `cueapi_claim_execution` | `execution_id`;可选 `worker_id` | 自动声明一次执行。 |
| `cueapi_claim_next_execution` | `task_name`， `worker_id` (可选) | 申请最古老的可申请死刑。 |
| `cueapi_execution_heartbeat` | `execution_id`， `worker_id` (需要) | 延长债权租赁； `worker_id` 在旅行中 `X-Worker-Id` 头。 |
| `cueapi_report_outcome` | `execution_id`， `outcome` (需要);可选证据字段 | 报告一次写的结果和证据。 |

## 开发

```bash
npm install
npm run build   # tsc -> dist/
npm test        # node test runner over test/*.test.ts, no network (fake fetch fixtures)
npm run dev     # run the CLI from source via tsx
```

## 许可证

MIT -见 `LICENSE`.

## 常见问题

### @reneturcios/cueport 是什么？

CueAPI代理——来自MCP主机或CLI的工作调度：创建、触发、暂停和更新提示，列出和声明执行，发送心跳，并报告带有证据的结果。一个bin提供一个小型CLI和一个studio MCP服务器。

### 如何安装 @reneturcios/cueport？

在项目目录运行 npm install @reneturcios/cueport，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cueport，可以用 npx cueport 直接运行。

### @reneturcios/cueport 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/reneturcios\_\_cueport 是否存在。

### @reneturcios/cueport 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @reneturcios/cueport 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @reneturcios/cueport 可以商用吗？

@reneturcios/cueport 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @reneturcios/cueport 还在维护吗？

最新版本 0\.1\.0 发布于 2026/11/02（1 天前）；至今共发布 2 个版本，其中过去 12 个月发布了 2 个；首次发布于 2026/11/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。