Skip to main content
Glama
Sign In

apis-io

by io.apis
OverviewDiscussionsAdmin

get_api

Read-only

Full detail for one API by aid (provider:api-slug); set include=["content"] to inline artifact bodies. Results carry next: the sub-resources that exist for this entity and the exact tool call that retrieves each, computed from this record. Pass include_next=false to omit it.

Input Schema

NameRequiredDescriptionDefault
aidYesAPI id in the form provider:api-slug, as find_apis returns it, e.g. "stripe:stripe-api".
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.
include_nextNoSet false to omit the `next` affordance block.
artifact_typesNoOnly return artifacts of these types, e.g. ["OpenAPI"].

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field 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."
  2. Changed3 schema fields changed
    • addedInput schema / properties / aid / description
      Added value: +"API id in the form provider:api-slug, as find_apis returns it, e.g. \"stripe:stripe-api\"."
    • addedInput schema / properties / artifact_types / description
      Added value: +"Only return artifacts of these types, e.g. [\"OpenAPI\"]."
    • addedInput schema / properties / include / description
      Added value: +"Pass [\"content\"] to inline each artifact's body instead of just its URL."
  3. Changed1 schema field changed
    • addedInput schema / properties / context
      Added value: +{
+  "description": "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.",
+  "type": "string"
+}
  4. Changed1 schema field changed
    • addedInput schema / properties / include_next
      Added value: +{
+  "default": true,
+  "description": "Set false to omit the `next` affordance block.",
+  "type": "boolean"
+}
  5. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds real behavioral value beyond that: the `next` block is computed from this record, it enumerates existing sub-resources with their exact tool calls, and include_next=false suppresses it. It does not describe pagination or the record's field shape.

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?

Three dense but purposeful sentences: the core purpose leads, then the include affordance, then the `next` return behavior. No filler sentences, though the dense backtick-heavy phrasing is slightly taxing to parse.

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?

Read-only with no output schema, so the description must carry return-value context. It explains the `next` affordance well, which is the least discoverable part of the response, but says nothing about the primary API record's fields or overall result shape that an agent will actually consume.

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

Parameters3/5

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

Schema description coverage is 100%, so all five parameters are already documented in the schema. The description largely restates the include and include_next semantics rather than adding syntax or format detail beyond them. Baseline 3 applies when the schema carries the burden.

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?

The description names a specific verb and resource with scope ("Full detail for one API by aid") and pins the identifier format to its producer ("as find_apis returns it"). It does not explicitly differentiate itself from close siblings like get_openapi or get_api_artifacts, but the include/next mechanics make the relationship inferable.

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

Usage Guidelines3/5

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

Usage is implied: call this once you have an aid from find_apis to get full detail. There is no explicit when-to-use-vs-alternative guidance, nor any statement of when not to use it (e.g. bulk fetches). The mention that `next` routes to sub-resource tools is helpful routing context but not exclusion guidance.

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
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources