Skip to content
← Public packages

@kody/api-research

Research third-party APIs: registry search, provider discovery, OpenAPI summarize, and client scaffold.

README.md

45 lines · 1.8 KB · Markdown

@kody/api-research

Intent

Give agents a reusable library for researching a third-party API before they write a package: summarize an OpenAPI 3.x spec and scaffold a small ESM client. Auth still comes from a saved integration or secrets — this package never stores credentials or widens host approval.

Prefer community_search for a product helpers package first. For integrations.sh registry search, detect, surface, or discover, fork @kody/integrations-sh — this package still exports search-registry and discover for existing callers. Use this library when nothing close exists and you need an operation inventory or a starting client.ts. For a named bind-and-call snapshot (the old kody.openapi["name"].operation() surface), fork @kody/openapi instead. This research library does not store bindings.

What it does

  • Search the public integrations.sh registry for a provider domain
  • Discover provider surfaces and credential types for a hostname
  • Fetch, parse, and summarize OpenAPI 3.x specs (bounded HTTPS)
  • Scaffold a small dependency-free ESM client from selected operations
  • Smoke-test registry search plus local parse/summarize without mutating

Prerequisites / setup

No package secrets. Registry and discover hit public integrations.sh APIs. Fetching a remote OpenAPI document needs host approval for that HTTPS URL. Scaffolded clients still require their own integration or secret approvals — this package never stores credentials.

Agents: import paths, smoke checks, and snippets live in AGENTS.md.

Done when

  • smoke-test returns { ok: true } with registry hits and a parsed ping operation
  • You can search → discover → summarize → scaffold without pasting tokens

Branding

icon.svg is a simple research/spec mark for this utility. Keep the MIT license and this Intent section when forking.