Skip to main content
Glama

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

TableJSON Schema
NameRequiredDescriptionDefault
aidYes
contextNoOptional: 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.
includeNo
include_nextNoSet false to omit the `next` affordance block.
artifact_typesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
+}
  2. Changed1 schema field changed
    • addedInput schema / properties / include_next
      Added value: +{
+  "default": true,
+  "description": "Set false to omit the `next` affordance block.",
+  "type": "boolean"
+}
  3. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already mark the tool read-only. The description adds useful behavioral context: include=['content'] inlines artifact bodies, results carry a dynamic `next` block with sub-resource tool calls computed from the record, and include_next=false omits it. This gives an agent a much clearer picture of the response shape beyond the schema alone.

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

Conciseness5/5

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

Two sentences contain all key information without fluff. The main purpose is front-loaded, and the optional behavior details are compactly packed into the second sentence. Each clause earns its place.

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

Completeness3/5

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

Core usage is clear and the `next` behavior is described, but there is no output schema, and the description only vaguely promises 'full detail'. The artifact_types parameter is undocumented, and the full return payload isn't summarized beyond the next affordance, leaving some ambiguity for an agent.

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 only 40%, so the description must compensate. It does explain aid format, include's allowed value and effect, and include_next's behavior. However, artifact_types is left completely unexplained in both the schema and the description, leaving a meaningful gap for a five-parameter tool.

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

Purpose5/5

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

The description states a specific verb and resource: 'Full detail for one API by aid (provider:api-slug)'. This clearly identifies the tool as a single-entity detail fetcher, distinguishing it from siblings like get_api_artifacts or find_apis that serve different retrieval purposes.

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?

The description implies when to use it — when you have an aid and want full detail for one API — and explains optional arguments like include and include_next. However, it never explicitly contrasts it with alternatives such as find_apis, get_provider_apis, or get_openapi, so an agent must infer the boundary.

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
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources