关于 origin-api
这是一项面向 Cursor Origin API 开发者的文档指引技能,帮助定位相关接口规范,并提示仓库类型、事件订阅、Webhook 验证、权限范围和不透明标识符等规则。
主要功能
- 01定位相关 API 文档
- 02检查原生与镜像仓库限制
- 03核对事件订阅要求
- 04验证并去重 Webhook 投递
- 05根据 API 规范确定权限范围
- 06将令牌和 ID 视为不透明值
适用场景
- 01查找特定 API 问题对应的规范
- 02实现前检查 Webhook 处理方式
- 03确定应用操作所需的权限范围
- 04审查集成迁移时的行为差异
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ cursor/ plugins --skill origin-api安装后在 Claude Code 中输入/origin-api确认已加载。
详细介绍
Origin API
文档是事实依据。切勿凭记忆写出端点、作用域、事件标识、请求头或限制。如果本文档与官方文档不一致,以官方文档为准。
文档位于 https://cursor.com/docs/api/origin/。llms.txt 是索引,链接到每个章节、端点和 Webhook 负载。openapi.yaml 是契约,“Endpoint reference” 说明其中的 x-origin-* 扩展。“llms-full.txt” 将完整参考内容汇集在一个文件中。“changelog” 说明了内容的变更。如果只需解答一个问题,请从 llms.txt 开始,并且只获取解答该问题的章节。llms-full.txt 和 openapi.yaml 都有数百 KB,无法一次性全部读入上下文。如果需要查阅全部文档(例如编写迁移说明时),请尽可能将它们保存在本地,且不要放在正在处理的任何代码库中;搜索所需的章节标题或注解,然后只阅读匹配部分。引用 operationId 和章节名称。
首先检查以下规则
- 原生还是镜像。 代码库要么是原生代码库(在 Origin 上创建),要么是 GitHub 镜像。在原生代码库上,安装拥有完整作用域和所有写入权限。在 GitHub 镜像上,除
repository.pushed以外的所有事件仍会送达;除元数据和内容读取以外的所有调用都会返回403;且无法合并拉取请求或更改默认分支(“Mirrored repositories”、“Events”)。 - 订阅。 只有
installation.*事件无需订阅即可送达。未订阅时不会有任何响应,而非返回错误(“Events”)。 - 验证、去重、确认。 在解析前,先根据原始正文验证签名;根据投递 ID 去重;返回
2xx,然后再处理(“Signature verification”、“Retries”、“Automatic disable”)。Origin 对摘要进行签名,而 Standard Webhooks 不会,因此通用验证器会失效。 - 根据规范确定作用域。 请求应用所调用操作的
x-origin-scopes.scopes并集(“Scopes”)。 - 令牌和 ID 均视为不透明值。 不要构造或解析分页令牌或 ID(“Pagination”、“IDs”)。
索引中不容易看出的一处章节:乱序到达的检查运行发布请求会发生什么,详见“Ordering writes”。
要迁移现有的 GitHub App:在此插件中使用 port-github-app-to-origin。
评论
支持 Markdown