Ai Readiness

by postmanlabs67cff8f385d8No licenseListed Oct 8, 2026Updated Oct 8, 2026

Scores a Postman collection or an OpenAPI spec for how well an AI agent can discover, understand, call, and recover from errors with it — missing examples, undocumented errors, and ambiguous parameters all cost points. Use when the user asks "is my API agent-ready," "can AI agents use my API," "how agent-friendly is my API," or wants to scan, score, or improve a collection or spec for AI/agent consumption. Covers `postman collection ai-readiness` and `postman spec ai-readiness`.

Instructions onlySoftware Development
AI-generated overview

Scores a Postman collection or OpenAPI spec for how well AI agents can discover, understand, call, and recover from errors with it.

What it does
This skill explains how to run the Postman AI readiness check against either a Postman collection or an OpenAPI specification, using the collection ai-readiness or spec ai-readiness command. It describes the readiness score and bucket (Limited, Fair, Good, Excellent) and the confidence level the command prints, and how to interpret them. It also covers reporting which verb and target were scored, the output mode, and any minimum-score exit code, and suggests offering a CI gate with a minimum score.
When to use it
Use it when a user asks whether their API is agent-ready, whether AI agents can use their API, or how agent-friendly it is. It also fits requests to scan, score, or improve a collection or spec for AI or agent consumption.
Requirements
Requires the Postman CLI commands collection ai-readiness and spec ai-readiness, plus a target Postman collection or OpenAPI spec, referenced by cloud ID or local file path. No scripts ship with the skill; it is instructions only. It references the collection-schema-v3 and ci-integration skills.

AI Readiness

Overview

An "agent-ready" API is one that an AI agent can discover, understand, call correctly, and recover from errors without human intervention. Most APIs aren't there yet.

Two ways to run this check, same rubric family, different target — pick by what exists:

  • collection ai-readiness <collectionId/path> scores a Postman collection — by cloud ID, local file path, or a postman/collections/<name> local-mode directory.
  • spec ai-readiness <spec> scores an OpenAPI specification directly — by cloud ID or local file path — with no collection involved at all.

Scoring

The command computes and prints the score itself — read the fields it gives you, don't recompute them:

  • readiness (score 0-100 + bucket) is the headline number. Buckets, low to high: Limited → Fair → Good → Excellent.
  • confidence (high/medium/low) says how many signals it could actually measure vs. had to mark unknown — a data-quality caveat, not part of the score.

Interpreting Results

Report the bucket, score, and confidence the command actually printed — don't infer a percentage band. Doc coverage is a modifier via its adjustment, not a separate gate; call it out by name when it's low, since recommendations flag that first. Also state which verb ran (collection vs. spec ai-readiness), which target was scored (local path vs. cloud ID), the output mode, and — if --min-score was set — the resulting exit code, not just "it passed."

You can ask user if they would like to set this check with a min score guarantee to run on their CI.

Reference

  • collection-schema-v3 skill — what saved examples and descriptions look like in the git-synced format this command reads.
  • ci-integration skill — where --min-score fits as a pipeline gate alongside spec lint/collection lint/workspace lint.

Source and attribution

Source:postmanlabs/postman-plugininskills/ai-readinessat commit67cff8f

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

More from postmanlabs/postman-plugin

Performance Testing

postmanlabs

Runs Postman collection load tests with virtual users, load profiles, and pass/fail thresholds.

Software DevelopmentOct 8, 2026

Flows

postmanlabs

Operate Postman Flows from the CLI: list, run, trigger, deploy, update, and debug flows and their runs.

DevOps & CloudOct 8, 2026

Ci Integration

postmanlabs

Adds Postman CLI checks as separate pass/fail gates in a CI pipeline.

DevOps & CloudOct 8, 2026

Api Testing

postmanlabs

Runs tests against an API from the command line — a single ad-hoc request, a full collection of pm.test assertions, or matching real captured app traffic against a collection contract. Use when the user asks to "test this endpoint," "run this collection," "check the API still works," or "verify my app's requests match the contract." Covers `postman request`, `postman collection run`, and `postman application test`. Depends on bootstrap when the target is a cloud collection or workspace-bound environment; a bare URL or local collection needs nothing from bootstrap.

Awaiting classificationOct 8, 2026

Api Monitoring

postmanlabs

Creates, schedules, and manages Postman Monitors — recurring checks against a live API — triggers ad hoc runs, inspects job/run history to diagnose failures, and hosts self-hosted execution runners for monitors on a private network. Use when the user asks to "set up a monitor," "run this monitor now," "check monitor results," "pause/resume a monitor," or "set up a runner for our internal APIs." Covers `postman monitor` (create, update, delete, list, get, pause, resume, run, jobs, runs) and `postman runner` (start, list, regions).

Awaiting classificationOct 8, 2026

Api Mocking

postmanlabs

Creates and runs fake API backends locally or in the cloud, with scenario and status-code overrides for testing.

Software DevelopmentOct 8, 2026