Skip to main content
Glama

Get the API specification

get_api_spec
Read-onlyIdempotent

Returns the OpenAPI specification of the algoum API as JSON: all endpoints and parameters, response and error schemas, pagination, timestamps and rate limit. Call it when a tool's description is not enough, for example to look up a response field or an error code.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuine value by disclosing what the payload contains (error schemas, pagination, rate limit). It does not warn about payload size/token cost, which is the main behavioral risk for a whole-spec dump, so it stops short of a 5.

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, front-loaded with the return value and followed by the routing condition. Every clause earns its place, with no restatement of the title or annotations.

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

Completeness5/5

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

With no output schema, the description must convey the return shape, and it does so thoroughly (JSON OpenAPI spec covering endpoints, params, schemas, pagination, timestamps, rate limit). Nothing an agent needs to call this zero-arg tool correctly is missing.

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?

The tool takes zero parameters, which is the baseline-4 case. The description correctly implies a single no-argument call and adds no misleading parameter language.

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?

States a specific verb and resource ('Returns the OpenAPI specification of the algoum API as JSON') and enumerates the contents (endpoints, parameters, response/error schemas, pagination, timestamps, rate limit). This clearly separates it from the data-retrieval siblings like events_get or filings_get, which return business data rather than the spec itself.

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

Usage Guidelines5/5

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

Gives an explicit trigger condition — 'Call it when a tool's description is not enough' — plus concrete examples ('to look up a response field or an error code'). An agent knows exactly when to fall back to this tool instead of the domain siblings.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources