Skip to main content
Glama
Sign In

apis-io

by io.apis
OverviewDiscussionsAdmin

find_overlays

Read-only

OpenAPI Overlays across the catalog. Documents applied on top of an API contract to add or change what it says. meta says who wrote it (authorship: provider / derived / generated / unmarked), whether the provider hosts it (provider_hosted — the only kind the Kin Score credits), what the actions touch (purpose), the action counts and the contract it extends. Filter by q / tags / providers; include=["content"] inlines bodies. Use find_artifacts for cross-type search.

Input Schema

NameRequiredDescriptionDefault
qNoFree text over name + description, e.g. "sms".
pageNoPage number, 1-based (default 1).
sortNoOrder: relevance / provider / name, or action_count / target_count (largest first).
tagsNoTag slugs, e.g. ["payments"]. On providers: what the company does (see api_tags).
limitNoResults per page, 1-100 (default 25).
matchNoHow `tags` combine: any (default) or all.any
contextNoOptional: one sentence on why you are asking. Never used to rank; read only if a result is wrong.
includeNoPass ["content"] to inline each artifact's body instead of just its URL.
purposeNoWhat the actions touch: "phrasing" (x-apievangelist-phrasing per operation), "servers", "documentation", "security", "removal", "update".
providersNoProvider slugs, e.g. ["stripe"].
authorshipNoWho wrote the overlay: "provider" (published or hosted by the provider), "derived" (API Evangelist, from the provider's contracts), "generated" (API Evangelist tooling — most are conversational phrasing), "unmarked" (no record; never presented as the provider's).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changed
    • changedInput schema / properties / context / description
      Previous value: -"Optional: why you are asking. One sentence — the task you are trying to complete, or what you expect to get back. Never included in the answer and never used to rank; it is read only when a result turns out to be wrong, which is when knowing the intent is what makes the report actionable."New value: +"Optional: one sentence on why you are asking. Never used to rank; read only if a result is wrong."
    • changedInput schema / properties / match / description
      Previous value: -"How multiple `tags` combine: \"any\" (default, at least one) or \"all\" (every tag)."New value: +"How `tags` combine: any (default) or all."
    • changedInput schema / properties / page / description
      Previous value: -"Page number, 1-based (default 1). Use with `limit` to walk a long list."New value: +"Page number, 1-based (default 1)."
    • changedInput schema / properties / providers / description
      Previous value: -"Provider slugs to restrict results to, e.g. [\"stripe\",\"adyen\"]."New value: +"Provider slugs, e.g. [\"stripe\"]."
    • changedInput schema / properties / q / description
      Previous value: -"Free text over name + description."New value: +"Free text over name + description, e.g. \"sms\"."
    • changedInput schema / properties / tags / description
      Previous value: -"Tag slugs. On PROVIDERS this is identity — what the company says it does, from its own apis.yml. A resource or operation term (webhook, saml, order, oai-pmh) will correctly match no provider; use find_apis?tags= for those, or find_providers?api_tags= to reach companies whose APIs merely touch it."New value: +"Tag slugs, e.g. [\"payments\"]. On providers: what the company does (see api_tags)."
  2. Changed5 schema fields changed
    • addedInput schema / properties / include / description
      Added value: +"Pass [\"content\"] to inline each artifact's body instead of just its URL."
    • addedInput schema / properties / limit / description
      Added value: +"Results per page, 1-100 (default 25)."
    • addedInput schema / properties / match / description
      Added value: +"How multiple `tags` combine: \"any\" (default, at least one) or \"all\" (every tag)."
    • addedInput schema / properties / page / description
      Added value: +"Page number, 1-based (default 1). Use with `limit` to walk a long list."
    • addedInput schema / properties / providers / description
      Added value: +"Provider slugs to restrict results to, e.g. [\"stripe\",\"adyen\"]."
  3. Added

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnlyHint and openWorldHint, so the description carries the load and does well: it discloses the returned meta fields (authorship classification, provider_hosted, purpose, action counts, extended contract). It notably adds that provider_hosted is 'the only kind the Kin Score credits', a behavioral/ranking nuance absent from structured data.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Roughly five dense sentences with no filler, and the resource definition is front-loaded before the filter/meta details. The middle meta sentence is long and parenthetical-laden, which slightly hurts scanability, but every clause carries information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With 11 parameters and no output schema, the description appropriately spends its budget on what gets returned (authorship, hosting, purpose, counts) and on filtering/inclusion. An agent has enough to invoke it correctly, though pagination/sorting behavior isn't restated in prose.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description goes beyond the schema by enumerating the authorship taxonomy and purpose categories and clarifying semantics of the returned metadata. The value-adds such as the Kin Score credit rule and the include behavior justify above baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States the resource precisely ('OpenAPI Overlays across the catalog') and immediately defines what an overlay is ('Documents applied on top of an API contract to add or change what it says'), so the agent knows the object type even though the verb is only implied by the name. It also names a sibling ('Use find_artifacts for cross-type search'), which separates it from adjacent search tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives concrete filtering guidance ('Filter by q / tags / providers'), tells how to get bodies ('include=["content"] inlines bodies'), and routes cross-type searching to find_artifacts. It stops short of explicit when-not-to-use conditions or prerequisite context, but the alternative is named.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All apis-io toolsInspect
Try in Browser
Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources