mcpField
O
ops-integrate

ops-integrate

github.com/davepoonDevelopment3.7k69 installsUpdated today
Repository

About ops-integrate

ops-integrate is a skill for adding external APIs to OPS, for users configuring service integrations. It guides API discovery, credential checks, and local registration.

Key features

  1. 01Find API docs and auth details
  2. 02Collect and save credentials locally
  3. 03Run endpoint health checks
  4. 04Register and list integrations

Use cases

  1. 01Add a third-party API
  2. 02Review registered services
  3. 03Check whether credentials work

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/davepoon/buildwithclaude --skill ops-integrate

After installing, type/ops-integratein Claude Code to confirm it loaded.

Details

From the project README

Runtime Context

PREFS="${CLAUDE_PLUGIN_DATA_DIR:-$HOME/.claude/plugins/data/ops-ops-marketplace}/preferences.json"
PARTNER_REGISTRY=$(jq '.partner_registry // {}' "$PREFS" 2>/dev/null || echo '{}')

Parse $ARGUMENTS:

  • Contains --list → run List registered integrations then exit
  • Otherwise → run Onboarding flow with the service name as first positional argument

OPS ► INTEGRATE

List registered integrations (--list)

jq -r '.partner_registry // {} | to_entries[] | "\(.key): \(.value.base_url) [\(.value.auth_type)]"' "$PREFS" 2>/dev/null

Display as a table:

Registered integrations:
  hubspot       https://api.hubapi.com          [bearer]
  stripe        https://api.stripe.com          [bearer]
  sendgrid      https://api.sendgrid.com        [api-key]

If no integrations registered: No integrations registered yet. Run /ops:integrate <service-name> to add one.

Onboarding flow (5 steps)

Step 1 — Discover API details

If --url not provided, use WebSearch to find:

  • Official API docs URL
  • Base API URL
  • Authentication pattern (bearer token / api-key header / basic auth / oauth2)
  • API key generation URL (where the user gets credentials)
  • Health/test endpoint (e.g., /healthz, /v1/ping, /me)
Step 2 — Confirm with user

Present findings via AskUserQuestion (≤4 options):

Found: <service-name> API — Base URL: <url> — Auth: <auth-type>
[Looks correct — continue]  [Change base URL]  [Change auth type]  [Cancel]

If "Change base URL": AskUserQuestion with free-text input for the new URL. If "Change auth type": AskUserQuestion (≤4 options): [bearer] [api-key] [basic] [oauth2]

Step 3 — Collect credential
Paste your <service-name> <auth-type> credential (it will be stored locally only)
[Paste now]  [Configure later]

If "Paste now": collect credential via AskUserQuestion free-text. Derive key name: <lowercase_service_name>_api_key

Write to preferences.json via atomic tmpfile swap:

tmp=$(mktemp)
jq --arg k "$KEY_NAME" --arg v "$CREDENTIAL" '.[$k] = $v' "$PREFS" > "$tmp" && mv "$tmp" "$PREFS"
Step 4 — Health check

Curl the health/test endpoint with the credential:

# Bearer token
curl -sf -o /dev/null -w "%{http_code}" \
  -H "Authorization: Bearer ${CREDENTIAL}" \
  "${BASE_URL}${HEALTH_ENDPOINT}"

# API key header (X-Api-Key)
curl -sf -o /dev/null -w "%{http_code}" \
  -H "X-Api-Key: ${CREDENTIAL}" \
  "${BASE_URL}${HEALTH_ENDPOINT}"

# Basic auth
curl -sf -o /dev/null -w "%{http_code}" \
  -u "${CREDENTIAL}:" \
  "${BASE_URL}${HEALTH_ENDPOINT}"

Report: ✅ if HTTP 200-299, ⚠️ with status code otherwise. If credential not yet configured, skip health check and report ⬜ health check skipped — credential not configured.

Step 5 — Register in partner registry
tmp=$(mktemp)
jq --arg name "${SERVICE_NAME}" \
   --arg url "${BASE_URL}" \
   --arg auth "${AUTH_TYPE}" \
   --arg key_name "${KEY_NAME}" \
   --arg health "${HEALTH_ENDPOINT}" \
   '.partner_registry[$name] = {base_url: $url, auth_type: $auth, credential_key: $key_name, health_endpoint: $health, added: (now | todate)}' \
   "$PREFS" > "$tmp" && mv "$tmp" "$PREFS"

Confirmation output:

✅ <service-name> registered in partner registry
   Auth: <auth-type>
   Health: <base-url><health-endpoint>
   Credential key: <key-name>

   Access via: jq '.partner_registry["<service-name>"]' $PREFS

CLI/API Reference

# List all registered integrations
jq '.partner_registry' "${CLAUDE_PLUGIN_DATA_DIR:-$HOME/.claude/plugins/data/ops-ops-marketplace}/preferences.json"

# Look up a specific integration
jq '.partner_registry["hubspot"]' "$PREFS"

# Read a credential for a registered integration
jq -r ".$KEY_NAME" "$PREFS"

# Remove an integration from the registry
jq 'del(.partner_registry["<service-name>"])' "$PREFS" > tmp && mv tmp "$PREFS"

Comments

Markdown supported