@reneturcios/cueport

中文文档
0.1.0发布于 2026/11/02MITES Module

CueAPI agent-work scheduling from an MCP host or CLI: create, fire, pause and update cues, list and claim executions, send heartbeats, and report outcomes with evidence. One bin serves a small CLI and a stdio MCP server.

原始使用文档
文档目录6 节
  1. Install
  2. CLI
  3. MCP server
  4. Tools
  5. Development
  6. License

cueport

cueport gives an MCP host or a terminal access to CueAPI, the coordination layer for agent work: schedule cues (recurring cron or one-time), fire them on demand, watch their executions, claim worker executions, keep a claim alive with heartbeats, and close the loop by reporting an outcome backed by evidence. One binary serves a command-line interface and a stdio MCP server.

An API key is required. Set CUEAPI_API_KEY to a key from your CueAPI account; every call sends it as Authorization: Bearer <key>, and a missing key fails before any request is attempted. Self-hosting or testing against another host? Set CUEAPI_BASE_URL alongside the key; when it is unset, calls go to https://api.cueapi.ai.

Install

npx @reneturcios/cueport list-cues

Or run the container image:

docker run -i ghcr.io/cloudcorprecords/cueport

The container defaults to the MCP server (see below). Pass CLI arguments to use it as a CLI instead.

CLI

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

Commands print the upstream JSON payload. Exit codes: 0 on success, 1 when a call fails (including a missing API key or an upstream API error), 2 for usage errors.

Two behaviours are worth knowing. Pausing and resuming are not separate endpoints: both are a PATCH /v1/cues/{id} carrying only a status field (paused or active). And claim-next is a fan-out, not a single call: the claim endpoint has no task filter, so the tool first fetches the server-side filtered claimable list, picks the oldest entry, and then claims that execution by id.

MCP server

One bin serves both faces. The mcp subcommand starts a stdio MCP server:

npx -y @reneturcios/cueport mcp

MCP client configuration:

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

Add CUEAPI_BASE_URL to the env block to point the server at a different CueAPI-compatible host.

Tools

ToolInputWhat it does
cueapi_create_cuename, schedule (required); optional description, callback, method, timezone, payload, task and platform fieldsCreate a recurring or one-time cue.
cueapi_list_cuesstatus, limit (optional)List cues, filtered by status.
cueapi_get_cuecue_idFetch one cue.
cueapi_fire_cuecue_id; optional payload_override, merge_strategy (merge default, or replace)Fire a cue immediately.
cueapi_update_cuecue_id plus any mutable cue fieldsSparse update; only provided fields are sent.
cueapi_pause_cuecue_idPause a cue (PATCH with status paused).
cueapi_resume_cuecue_idResume a cue (PATCH with status active).
cueapi_delete_cuecue_idDelete a cue permanently.
cueapi_list_executionscue_id, status, limit (optional)List executions, filtered by cue and status.
cueapi_get_executionexecution_idFetch one execution, with state and outcome.
cueapi_list_claimable_executionstask, agent, limit (optional)List unclaimed worker executions, filtered server-side.
cueapi_claim_executionexecution_id; optional worker_idAtomically claim one execution.
cueapi_claim_next_executiontask_name, worker_id (optional)Claim the oldest claimable execution.
cueapi_execution_heartbeatexecution_id, worker_id (both required)Extend a claim lease; worker_id travels in the X-Worker-Id header.
cueapi_report_outcomeexecution_id, outcome (required); optional evidence fieldsReport a write-once outcome with evidence.

Development

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

License

MIT — see LICENSE.

版本与发布记录

@reneturcios/cueport 共发布 2 个版本,首次发布于 2026/11/02;过去 12 个月发布了 2 个版本。

版本发布日期距今
0.1.0latest2026/11/021 天前
0.0.0-stage2026/11/021 天前

关于 @reneturcios/cueport 的常见问题

@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 和提交记录判断。