Check specification

agents-json 1.0.0

agents.json

Validates Wildcard-style agents.json discovery for OpenAPI-based agent workflow contracts without executing workflows.

Assessment Suite
2026.06.10
Maturity
Emerging recommendation
Category
Agent Ease of Use
Subcategory
Agent Capability Discovery

1. Abstract

Publish a Wildcard-style agents.json file so agents can discover OpenAPI-backed workflows, links, examples, and authentication requirements.

Wildcard agents.json gives agents workflow-level context beyond plain OpenAPI, including flows, links, examples, and API action structure. It is an emerging OpenAPI-adjacent proposal, so scanners should validate the contract shape without treating it as an A2A or IETF standard.

2. Classification

Check ID
agents-json
Check version
1.0.0
Package path
lib/checks/agents-json/versions/1.0.0
Category
Agent Ease of Use
Subcategory
Skill Discovery
Check group
Agent Capability Discovery
Check group ID
agent-capability-discovery
Maturity
Emerging recommendation
Scope
site
Check weight
1

3. Input And Output Contracts

Resources inspected
/.well-known/agents.json, /agents.json

4. Scoring Semantics

Step IDTitleWeightDescription
discover-agents-jsonDiscover agents.json0.2Fetch preferred and fallback Wildcard agents.json discovery paths.
validate-schema-shapeValidate Wildcard schema shape0.2Validate that the document is a Wildcard-style OpenAPI workflow contract rather than a generic directory.
validate-actionsValidate API actions0.2Validate OpenAPI-derived action or operation definitions and parameter schemas.
validate-flows-linksValidate flows and links0.2Validate workflow flows and operation links without executing them.
examples-usabilityReview examples and LLM usability0.1Check examples and descriptions that help agents construct arguments.
security-hygieneReview public contract safety0.1Flag malformed auth declarations, public secrets, and unsafe URL boundaries.

5. Package Documentation

agents.json Check v1.0.0

Status

Abstract

This check validates Wildcard-style agents.json discovery for OpenAPI-based agent workflow contracts. It does not validate the older lightweight directory shape that only lists name and url, and it does not validate A2A Agent Cards.

Motivation

Wildcard agents.json is an emerging OpenAPI-adjacent proposal for describing API actions, flows, links, examples, and authentication context so agents can reason about workflows. A scanner can validate that the public contract is structurally useful without executing workflows or treating the proposal as an IETF, IANA, W3C, OpenAPI Initiative, or A2A standard.

Normative Model

The preferred discovery path is:

  • /.well-known/agents.json

The accepted fallback path is:

  • /agents.json

The expected document is a JSON object that resembles a Wildcard agents.json contract:

  • version or schema information when available.
  • site/API information.
  • OpenAPI reference or OpenAPI-like operations.
  • actions or operations.
  • flows.
  • links.
  • examples.
  • auth/security declarations.

Applicability

The check applies to public site origins. Absence is a warning by default because agents.json is an emerging readiness signal. A malformed published file fails because the site attempted the convention but produced unusable metadata.

Pass Criteria

The check passes when:

  • a candidate resource is found at the preferred path or accepted fallback.
  • the response body parses as a JSON object.
  • the document matches the Wildcard-style schema shape.
  • the document declares or implies a supported version.
  • API/action definitions are present and structurally valid.
  • flows are present and non-empty.
  • each flow references existing actions or operations.
  • links, when present, reference existing source and target actions or operations.
  • examples, when present, are parseable and attached to valid actions or flows.
  • parameter schemas are JSON Schema or OpenAPI-compatible objects.
  • auth/security declarations are structurally valid.
  • URLs are valid relative or HTTP(S) URLs.
  • no public credentials or secret-bearing URLs are present.

Warning Criteria

The check warns when:

  • /.well-known/agents.json is absent.
  • only /agents.json fallback is found.
  • JSON is parseable but served with a generic or incorrect content type.
  • the file matches the old lightweight directory shape instead of Wildcard shape.
  • schema/version information is missing but the document otherwise resembles Wildcard shape.
  • schema/version information is newer than the check supports.
  • flows are too thin to guide execution.
  • actions have weak descriptions.
  • examples are absent for complex actions.
  • parameters lack descriptions or examples.
  • links do not explain data mapping clearly.
  • remote OpenAPI or schema references are cross-origin.
  • auth/security declarations are present but incomplete.
  • OAuth is referenced without enough issuer, authorization server, or scope information.
  • roadmap-style features such as loops, conditionals, pagination, streaming, or failure handling are referenced without stable schema support.
  • workflow execution would require side effects, credentials, or payment.

Failure Criteria

The check fails when:

  • a published candidate is not parseable JSON.
  • the root document is not an object.
  • the document does not match the Wildcard-style schema shape.
  • required version/schema fields are malformed when present.
  • API/action definitions are missing.
  • flows are missing when the document claims executable workflows.
  • flows reference missing actions or operations.
  • links reference missing source or target operations.
  • parameter schemas are malformed.
  • examples are malformed or incompatible with declared schemas.
  • URLs are invalid.
  • auth/security declarations are malformed.
  • public credentials, API keys, Bearer tokens, passwords, or secret-bearing URLs appear in public fields.

Evidence Model

Evidence includes:

  • candidate paths attempted.
  • selected resource URL.
  • preferred or fallback path classification.
  • HTTP status and content type.
  • cache headers.
  • parse result.
  • detected schema/version.
  • schema-shape classification.
  • API/action count.
  • flow count.
  • invalid flow summaries.
  • link count.
  • invalid link summaries.
  • example count.
  • parameter schema validation summary.
  • auth/security summary.
  • remote reference list.
  • public-secret scan summary.
  • roadmap-feature indicators.

Validation And Scoring Steps

  • discover-agents-json (0.20): discover preferred and fallback agents.json paths.
  • validate-schema-shape (0.20): validate Wildcard-style schema shape.
  • validate-actions (0.20): validate API actions or OpenAPI operations.
  • validate-flows-links (0.20): validate flows and links without executing them.
  • examples-usability (0.10): review examples and LLM argument-generation usability.
  • security-hygiene (0.10): review public-contract security hygiene.

Standard Behavior

Wildcard agents.json proposes /.well-known/agents.json as a public workflow contract for agent-facing API execution. It builds on OpenAPI and adds workflow-level context such as flows, links, and examples.

Non-Standard And Real-World Behavior

Wildcard agents.json is an open proposal, not an IETF/IANA/W3C/OpenAPI Initiative/A2A standard. The check treats /agents.json as fallback evidence and labels old directory-only files as non-conformant to this check version.

Non-Goals And Limitations

  • Does not validate A2A Agent Cards.
  • Does not validate MCP Server Cards.
  • Does not execute workflows by default.
  • Does not send credentials.
  • Does not treat Wildcard agents.json as a standards-body specification.
  • Does not pass old name plus url directory files as Wildcard conformance.
  • Does not depend on the OpenAPI discovery check result.

References

Source: lib/checks/agents-json/versions/1.0.0/docs.md

6. Version Changelog

agents-json v1.0.0 Changelog

Initial Wildcard-style agents.json check.

  • Validates /.well-known/agents.json as the preferred discovery path.
  • Treats /agents.json as fallback evidence.
  • Checks OpenAPI-adjacent actions, flows, links, examples, schema shape, and public-contract security hygiene.
  • Rejects old directory-only name plus url files as Wildcard conformance.
  • Does not execute workflows or depend on the OpenAPI discovery check result.

Source: lib/checks/agents-json/versions/1.0.0/changelog.md