mcpField
I
inngest-api

inngest-api

github.com/inngest云与 DevOps29800 次安装4 周前更新
代码仓库

关于 inngest-api

inngest-api 是面向使用 Inngest 的开发者和 Agent 的技能，提供 REST API v2 的文档查找与原始 HTTP 操作指引。它涵盖账户、环境、运行、追踪和 Insights 等接口，并建议常见任务优先使用 Inngest CLI 或 MCP。

主要功能

  1. 01查找 REST API v2 文档与接口规范
  2. 02操作账户、环境、密钥和 Webhook
  3. 03查询应用、函数运行及追踪
  4. 04执行 Insights 查询
  5. 05遵循认证与变更安全规则

适用场景

  1. 01检查函数运行或事件运行追踪
  2. 02通过 HTTP 调用 CLI 未覆盖的接口
  3. 03查阅端点请求与响应结构
  4. 04在执行变更前核实目标环境

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/inngest/inngest-skills --skill inngest-api

安装后在 Claude Code 中输入/inngest-api确认已加载。

附带文件references/rest-api-v2.md

详细介绍

Inngest REST API v2

对于使用已连接 MCP 工具执行 Cloud 操作，优先使用 inngest-cloud。 仅在需要明确使用终端/HTTP，或 MCP 缺少相应功能时才使用此技能。如果 OAuth MCP 可以完成任务，请勿索要 API 密钥。

使用此技能执行原始 REST API v2 操作和查询 API 参考。如果可以通过 npx inngest-cli@latest api 完成任务，请改用 inngest-api-cli；CLI 对 Agent 来说更安全，因为它会处理目标/身份验证标志和端点命令连接。

优先使用 CLI

以下情况请使用 inngest-api-cli：

  • 根据运行 ID 或事件 ID 调试运行和跟踪。
  • 检查账户、环境、密钥、Webhook、应用同步和函数调用。
  • 执行 Insights 表/架构/查询工作流。
  • 检查本地开发服务器或 Cloud 操作。

仅在以下情况使用原始 REST API v2：

  • CLI 未提供所需端点。
  • 用户明确要求使用 HTTP、curl、fetch、OpenAPI 或 API 文档。
  • 需要检查请求/响应架构，再决定如何操作。

文档查询

需要准确性时，请获取最新文档，而不要猜测：

  • API 概览：https://api-docs.inngest.com/
  • 身份验证：https://api-docs.inngest.com/authentication
  • LLM 索引：https://api-docs.inngest.com/llms.txt
  • OpenAPI v2 规范：https://api-docs.inngest.com/api-specs/v2.json
  • Markdown 页面格式：在文档 URL 后添加 .md，例如 https://api-docs.inngest.com/v2/runs/GetFunctionTrace.md
  • 端点请求/响应架构： references/rest-api-v2.md

如果 Markdown 页面返回错误或未提供生成的参考详情，请使用 OpenAPI 规范查询方法、路径、参数、请求正文和架构。

基础 URL

  • Cloud v2：https://api.inngest.com/v2
  • 本地开发服务器 v2：http://localhost:8288/api/v2
  • API 文档称，也可以通过本地服务器 origin 访问开发服务器。发起本地请求前，请确认实际的开发服务器端口。

身份验证

REST API 使用 Bearer 令牌身份验证。

  • 对于来自 CI、脚本、工具和 Agent 的请求，优先使用 INNGEST_API_KEY。
  • 签名密钥主要用于与 Inngest 通信的应用；仅当这是可用且合适的凭据时，才将其用于 API 请求。
  • API 密钥仅用于 v2 端点。
  • 在默认生产环境以外操作时，请附加 X-Inngest-Env，或使用限定环境的 API 密钥。
  • 切勿粘贴、打印、提交或记录 API 密钥、事件密钥、签名密钥、Webhook URL 或解密后的密钥。

示例：

curl -fsSL \
  -H "Authorization: Bearer $INNGEST_API_KEY" \
  -H "X-Inngest-Env: $INNGEST_ENV" \
  https://api.inngest.com/v2/account

端点发现

以 OpenAPI 规范为准：

curl -fsSL https://api-docs.inngest.com/api-specs/v2.json

当前 v2 涵盖账户、环境、密钥、Webhook、应用、函数调用、事件运行查询、函数运行、跟踪、Insights 和合作伙伴 API。 端点覆盖范围可能会变化，因此编写原始请求前请检查规范。

对于仅限 API 或受访问权限限制的端点（例如合作伙伴账户端点），请在尝试调用前确认用户拥有所需权限。

请求规则

  • 根据 OpenAPI 确定方法、路径、查询参数、标头和正文。
  • 不要臆造未记录的请求字段。
  • 根据响应做出决定前，先使用结构化 JSON 解析。
  • 对于复杂 JSON，请使用正文文件或 here-doc，而不要使用经过 shell 转义的单行命令。
  • 当 page.hasMore 为 true 且需要完整结果时，请添加分页游标。
  • 如果列表响应缺少 data，且没有错误，则将其视为空列表。

变更安全

先读后写。执行原始 HTTP 变更前，请确认目标账户、环境、资源和意图，除非用户的指令已明确说明所有这些信息。

将以下操作类别视为会修改数据或产生副作用：

  • 创建或修补环境。
  • 创建 Webhook。
  • 同步应用。
  • 调用函数。
  • 创建合作伙伴账户。
  • 可能成本高昂或产生大量结果的广泛 Insights 查询。

输出处理

  • 总结 ID、名称、状态、分页信息和可采取行动的错误。
  • 对令牌值、Webhook URL、敏感负载字段和已解密的机密信息进行脱敏。
  • 除非用户提出要求，否则不要粘贴大量原始跟踪记录、完整的 OpenAPI 片段或完整的响应正文。
  • 如果身份验证失败，请先确认环境中是否存在凭据；然后让用户提供或轮换 INNGEST_API_KEY，不要将其粘贴到聊天中。

评论

支持 Markdown