SuperAPI AI 工具集

integration-patterns

编程与开发

查看项目

更新于 11-11 16:19

技能介绍

用途 本资料是构建 Prismatic Code Native Integrations(CNI)的参考文档,服务于在 Prismatic 平台上以 TypeScript 代码方式开发集成的场景,集中说明架构模式、组件清单用法、代码生成规范和分阶段参考资料索引。

主要能力与架构模式 资料给出两种架构模式。 1)标准集成模式:组件通过 manifests 和 componentRegistry 访问,使用标准连接配置,可任意组合组件与清单。 2)组件清单模式:所有组件都通过清单访问。安装命令为 prismatic-tools install-manifest <component-key>,在 componentRegistry.ts 中通过 componentManifests() 注册,导入 actions 后调用 .perform(),例如 import slackActions from "./manifests/slack/actions"; await slackActions.postMessage.perform({...})。相关说明见 references/manifest-pattern.md。

配置约定(Config Mantra) 每个配置元素都必须使用封装函数:configVar() 用于简单值,connectionConfigVar() 用于连接,dataSourceConfigVar() 用于数据源。详见 references/cni-examples/config-patterns-correct-vs-incorrect.md。

工具映射 资料列出若干已被替代的 MCP 能力:组件列表改用 run.ts find-components <keyword>,组件初始化改用 run.ts scaffold-component,组件发布改用 run.ts publish-component;清单在脚手架阶段自动生成;组件清单安装由 run.ts scaffold-project --components 处理(含 legacy 组件清单安装)。

内联 API 调研阶段 当 DAG 输出 status: "inline_task" 表示需要进行 API 调研时,应直接执行调研而不派生子代理。要点包括:首次 WebFetch 使用综合提示词抓取入口 URL,一次性提取认证、base URL、端点、webhook 与速率限制;去重时先剥离 #anchor 片段,因为同一页面上的不同锚点属于同一文档;仅对确实不同的 URL 路径做后续抓取;最多 10 次 WebFetch,不足则记录缺口继续推进;只使用官方文档域名,不采用第三方来源;认证优先级为 OAuth2 > API Key > Bearer Token > Basic Auth;输出为包含 authentication、baseUrl、resources、webhooks、rateLimiting 的结构化 JSON。连接配置模式见 references/cni-examples/component-auth-patterns.md。

分阶段参考文档 资料按工作流阶段组织参考材料,建议只加载当前阶段相关内容以控制上下文。 会话开始时加载 references/narration-guide.md(叙述风格、解释深度规则、阶段里程碑模板)。 Phase 2 需求收集:规格项自带 agent_context、implications 和 docs(Prismatic 文档 URL),通常无需外部参考,必要时按需抓取文档。 Phase 3 凭据收集:references/auth-setup.md。 Phase 4 脚手架:references/manifest-pattern.md、references/spectral-quickstart.md、references/spectral-types.md(SDK 类型的权威来源,YAML 规格与类型冲突时以类型为准)。 Phase 5 代码生成(主要阶段):优先加载 references/answer-to-code-cookbook.md(将 integration.yaml 答案映射为 TypeScript 代码片段,可按 cookbook_section 标题 Grep 定位);另含 spectral-types.md、code-generation-guide.md、code-anti-patterns.md、documentation-style.md(生成文档不出现第二人称、不出现产品名、使用主动语态)、config-patterns-correct-vs-incorrect.md、using-components.md、trigger-metadata-spec.md,结构模板位于 ${CLAUDE_PLUGIN_ROOT}/templates/integration/。条件加载:webhook 触发时加载 webhook-patterns.md 与 webhook-payload-access.md;批量流程加载 batch-flows.md;生命周期钩子加载 lifecycle-events.md;状态持久化加载 state-persistence.md;OAuth 连接加载 oauth-connection.md;多流程加载 multi-flow.md;数据源加载 data-sources.md;JSON 表单加载 json-forms.md;集成无关连接加载 integration-agnostic-connections.md;模板化连接加载 templated-connections.md;无可用组件时加载 direct-http-patterns.md。代码生成后运行 prismatic-tools verify-code 核对需求是否已转写进代码。 Phase 6-7 构建、部署与测试:references/troubleshooting-errors.md、references/cni-examples/testing-debugging.md、references/cni-examples/error-handling.md。 Phase 8 迭代:如遇连接问题加载 references/network-configuration.md。

完整参考清单 包括 narration-guide.md、answer-to-code-cookbook.md、code-anti-patterns.md、documentation-style.md、workflow-phases.md、workflow-guide.md、code-generation-guide.md、manifest-pattern.md、auth-setup.md、network-configuration.md、spectral-quickstart.md、trigger-metadata-spec.md、troubleshooting-errors.md,以及 cni-examples 下的 basic-api-to-slack.md、webhook-patterns.md、webhook-payload-access.md、lifecycle-events.md、state-persistence.md、config-patterns-correct-vs-incorrect.md、data-sources.md、json-forms.md、multi-flow.md、batch-flows.md、oauth-connection.md、using-components.md、error-handling.md、integration-agnostic-connections.md、templated-connections.md、testing-debugging.md、direct-http-patterns.md。

适用场景与限制 适用于正在开发或维护 Prismatic CNI 的开发者,尤其是需要遵循配置封装约定、选择架构模式、按阶段查阅示例与排错资料的场景。资料为参考文档与流程指引,未提供该技能的独立收费、价格或平台支持范围等信息。