mcpField
C
connector-dev

connector-dev

github.com/stahura数据与数据库24190 次安装26 周前更新
代码仓库

关于 connector-dev

面向 Domo Custom Connector IDE 项目的技能,指导开发者构建服务器端自定义连接器。内容涵盖认证、数据处理、分页和错误处理模式。

主要功能

  1. 01认证输入校验与凭据测试
  2. 02HTTP 状态码和错误处理
  3. 03JSON 数组解析与分页
  4. 04使用 Domo 库处理数据
  5. 05连接器开发检查清单

适用场景

  1. 01为外部 API 编写连接器认证
  2. 02处理 API 响应并实现分页
  3. 03检查连接器的数据列与错误处理

安装

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

$npx skills add https://github.com/stahura/domo-ai-vibe-rules --skill connector-dev

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

附带文件references/examples.md

详细介绍

适用范围

本技能适用于 Domo Custom Connector IDE 项目——不适用于 Domo App Platform 自定义应用/卡片构建。自定义连接器在通过 Connector Dev Studio 发布后于服务端运行。


文件结构

  • authentication.js — 验证凭据并对外部 API 进行身份验证
  • dataProcessing.js — 从外部 API 获取并处理数据
  • README.md — 记录可用的报告和参数

关键模式

身份验证
  • 在使用前清理凭据输入(用正则验证 API 密钥/令牌)
  • 设置必需的请求头,然后发起一个轻量级测试请求以验证凭据
  • 调用 auth.authenticationSuccess() 或 auth.authenticationFailed('reason') — 绝不能让身份验证状态不明确
数据处理
  • 在解析响应正文之前检查 httprequest.getStatusCode()
  • 对 JSON 数组响应使用 datagrid.magicParseJSON(jsonArray) — 避免手动映射列
  • 在 do...while 循环中处理分页;使用响应中的下一页链接或游标作为循环条件
  • 使用 metadata.report 在报告类型之间分支;使用 metadata.account.* 获取凭据
错误处理
  • 按状态码捕获 HTTP 错误;尝试解析错误正文以获得人类可读的消息
  • 如果错误正文不是可解析的 JSON,则回退到原始响应的子字符串
  • 重新抛出错误,以便连接器运行时能正确地将其暴露出来

规则

  1. 输入清理 — 始终清理输入(API 密钥、用户参数)以防止注入攻击
  2. 一致的列 — 每一行必须具有相同的列;对缺失值使用 null
  3. Domo 库 — 使用 Domo 提供的方法(httprequest、datagrid、auth、metadata);参见参考文档
  4. 清晰的错误消息 — auth.authenticationFailed() 消息应告诉用户需要修复什么

代码示例

如果你需要身份验证、数据处理或错误处理模式的完整样板代码,请阅读 references/examples.md。


检查清单

  • authentication.js 验证输入格式并测试凭据
  • authentication.js 适当调用 auth.authenticationSuccess() 或 auth.authenticationFailed()
  • dataProcessing.js 正确处理分页
  • dataProcessing.js 在解析 JSON 之前检查 HTTP 状态码
  • dataProcessing.js 对 JSON 数组使用 datagrid.magicParseJSON()
  • 所有输入均已清理
  • 错误消息清晰且可操作
  • README.md 记录了所有报告/参数
  • 所有行具有一致的列数

评论

支持 Markdown