Skip to content

Update to current Orbit API and bundle Orbit's MCP server - #1

Open
avdev4j wants to merge 8 commits into
Postman-Devrel:mainfrom
avdev4j:update-orbit-api-reference
Open

Update to current Orbit API and bundle Orbit's MCP server#1
avdev4j wants to merge 8 commits into
Postman-Devrel:mainfrom
avdev4j:update-orbit-api-reference

Conversation

@avdev4j

@avdev4j avdev4j commented Sep 3, 2026

Copy link
Copy Markdown

Why

The skill was pointing at fabric-gateway.postmanlabs.com/api/search, which no longer exists. Orbit's API is now at api.buildwithorbit.ai/v1/search, documented at buildwithorbit.ai.

Rather than just swap in the new URL and wait for the next move, this bundles Orbit's MCP server so the API contract lives server-side. Orbit can change its parameters without breaking installed copies of the plugin.

What changed

Bundles the MCP server. New .mcp.json points at https://mcp.buildwithorbit.ai/mcp (HTTP transport, no auth). Installing the plugin now wires up the search and integrate tools — no claude mcp add, no API key.

Skill drives the tools instead of curl. SKILL.md calls mcp__plugin_orbit_orbit__search / __integrate and keeps everything that is actually this plugin's value: capability decomposition, reading Not supported: lines as design gaps, iteration, saving the blueprint to orbit-output/.

Adds /v1/integrate. Turns chosen endpoints into a task brief covering auth requirements, base URLs, ordered request steps, and gotchas. Wired into the README's design process as step 5.

Corrects the parameters. The old reference had several wrong:

Old Current
cursor body field query parameter
limit undocumented query param, default 10, max 25
q unconstrained max 512 chars; any other body field returns 400
nextCursor string | null absent on last page, not null
result fields no resourceType adds resourceType; live API also returns provider/product
pagination unbounded caps at 40 results total

Keeps a REST fallback. references/orbit-api.md is rewritten against the published OpenAPI spec and retained for sessions where the MCP tools are unavailable.

Verification

Probed the MCP server directly over JSON-RPC (initializetools/listtools/call) and called both REST endpoints live. The tool schemas surfaced two constraints missing from the published OpenAPI spec, now documented:

  • integrate caps resources at 10 items
  • both tools accept an optional clientName for anonymous usage analytics

Also folded in Orbit's own query guidance from the tool description, since it materially affects result quality: include the provider name, one intent per call, no OR-separated queries.

Not verified

The scoped tool name mcp__plugin_orbit_orbit__search is derived from the documented mcp__plugin_<plugin>_<server>__<tool> format, not observed from a real install. Worth one /orbit:discover run against the installed plugin to confirm the tools resolve — if allowed-tools blocks them, that name is the thing to check.

Generated with Claude Code

avdev4j and others added 2 commits September 3, 2026 12:13
The endpoint moved from fabric-gateway.postmanlabs.com/api/search to
api.buildwithorbit.ai/v1/search. Corrected the parameters against the
published OpenAPI spec and verified both endpoints live:

- limit/cursor are query parameters, not body fields; q is the only
  accepted body field (max 512 chars) and unknown fields return 400
- meta.nextCursor is absent on the last page, not null
- results carry resourceType (plus provider/product from the live API)
- pagination caps at 40 results per query

Also adds the /v1/integrate endpoint, which turns selected search
results into a task brief covering auth, base URLs, and request steps.

Co-Authored-By: Claude <noreply@anthropic.com>
Ships .mcp.json so installing the plugin wires up Orbit's search and
integrate tools with no user setup (HTTP transport, no auth). The skill
now calls those tools instead of constructing curl commands, which moves
the API contract server-side — Orbit can change parameters without
breaking installed copies of the plugin.

The skill keeps everything that is actually this plugin's value: capability
decomposition, reading "Not supported" lines as design gaps, iteration, and
saving the blueprint to orbit-output/.

references/orbit-api.md is retained as a documented REST fallback for when
the MCP server is unreachable. Verified both tools live against
mcp.buildwithorbit.ai; their schemas also surface two constraints missing
from the published OpenAPI spec: integrate caps resources at 10, and both
tools accept an optional clientName for usage analytics.

Co-Authored-By: Claude <noreply@anthropic.com>
avdev4j and others added 2 commits September 3, 2026 12:46
Claude Code only reads .claude-plugin/plugin.json; the root-level
plugin.json was silently ignored (`claude plugin validate` reported
"Validating components" rather than a manifest). The plugin name would
have fallen back to the directory name, making the skill
/orbit-claudecode-plugin:discover and the MCP tools
mcp__plugin_orbit_claudecode_plugin_orbit__*, which would not have matched
the allowed-tools entries in SKILL.md.

Also drops the "skills" field (a Codex convention; Claude Code
auto-discovers skills/ at the plugin root) and adds author/homepage.

Adds .claude-plugin/marketplace.json so the repo is installable as a
marketplace, matching the pattern already used by devrel-claude-code-skills.

Verified end-to-end: plugin installs as orbit@orbit-marketplace, the
bundled MCP server reports plugin:orbit:orbit connected, and
/orbit:discover resolves mcp__plugin_orbit_orbit__search and completes a
real search plus integration brief.

Narrows the integrate guidance: the schema allows 10 resources, but a
5-resource call returned a one-line restatement instead of a brief while a
2-resource call returned the full document, so the skill now advises
several focused calls.

Co-Authored-By: Claude <noreply@anthropic.com>
`claude plugin add` is not a subcommand. Installing from a repo takes two
steps: register the marketplace, then install the plugin from it. Also
documents --plugin-dir for local development.

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread .claude-plugin/marketplace.json Outdated
"name": "Postman DevRel"
},
"metadata": {
"description": "Agent-friendly API discovery from the Postman API Network"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets not mention Postman API Network considering Orbit is a separate product.
We can say "Agent-friendly API discovery from Orbit" , for further description about Orbit, we can take inspiration from
our webpage

Comment thread .claude-plugin/marketplace.json Outdated
{
"name": "orbit",
"source": ".",
"description": "Discover APIs from the Postman API Network using Postman Orbit, an agent-friendly search API designed for AI-powered app design.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets remove mention of Postman API Network

Comment thread .claude-plugin/plugin.json Outdated
{
"name": "orbit",
"version": "1.1.0",
"description": "Discover APIs from the Postman API Network using Postman Orbit, an agent-friendly search API designed for AI-powered app design.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets remove Postman API Network

Comment thread skills/discover/SKILL.md Outdated
one-line restatement instead of a real brief. To cover more endpoints, make
several focused calls grouped by sub-task rather than one wide call.

Save the returned `taskBrief` to `orbit-output/<slugified-task>-brief.md`. It covers

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whats the idea behind saving the output, Haven't seen this pattern else where.

buildwithtalia and others added 3 commits September 9, 2026 11:13
Per review: writing results to disk is not a pattern used elsewhere, and
the skill has no reason to leave files behind. The search results and the
task brief are presented to the user in the conversation instead.

- skills/discover/SKILL.md: step 5 no longer writes the taskBrief to
  orbit-output/<task>-brief.md; step 6 becomes "Summarize" rather than
  "Save and summarize"
- README.md: drops the "Results are saved to orbit-output/" line and the
  "Save the blueprint" design-process step, which now ends at the task
  brief

Co-Authored-By: Claude <noreply@anthropic.com>
Comment thread orbit-output/geocode-an-address.md Outdated
@@ -0,0 +1,101 @@
# Orbit search: geocode an address

Queries run against the Postman API Network via Orbit MCP `search`.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Queries run against the Postman API Network via Orbit MCP `search`.
Queries run against Orbit's API registry via Orbit MCP `search`.

Comment thread skills/discover/SKILL.md Outdated
---
description: "Discover APIs from the Postman API Network using Orbit's agent-friendly search. Returns endpoints with evaluateGuide fields showing what each API can and can't do."
allowed-tools: ["Bash", "Write", "Read"]
description: "Discover APIs from the Postman API Network using Orbit's agent-friendly search. Returns endpoints with evaluateGuide fields showing what each API can and can't do, and can generate an integration task brief for the ones you pick."

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: "Discover APIs from the Postman API Network using Orbit's agent-friendly search. Returns endpoints with evaluateGuide fields showing what each API can and can't do, and can generate an integration task brief for the ones you pick."
description: "Discover public APIs using Orbit's agent-friendly search. Returns endpoints with evaluateGuide fields showing what each API can and can't do, and can generate an integration task brief for the ones you pick."

Comment thread skills/discover/SKILL.md Outdated
# orbit:discover

Search the Postman API Network for APIs matching a capability query.
Search the Postman API Network for APIs matching a capability query, then generate an

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Search the Postman API Network for APIs matching a capability query, then generate an
Search Orbit's API registry for APIs matching a capability query, then generate an

Per review: Orbit is a separate product, so the plugin should not present
itself as a front-end for the Postman API Network.

README.md
- Intro now matches the manifest wording: "Discover APIs using Postman
  Orbit, an agent-friendly search API designed for AI-powered app design"
- "Unlike browsing the Postman API Network in a browser" -> "an API catalog"
- Removed the Postman API Network entry from Links
- "How it works" table no longer credits the skill with a "saved
  blueprint", which went away with the file-saving pattern

skills/discover/SKILL.md
- Skill description and the opening line no longer name the API Network
- The agent-vs-human note now says "an API catalog in a web UI"
- Dropped "Write" from allowed-tools; the skill writes no files now

Deleted orbit-output/, which held two committed sample outputs. Nothing
referenced them and nothing produces them any more.

The "Orbit vs postman:search" comparison is left alone: it contrasts two
tools rather than positioning Orbit as part of the Network.

Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants