Skip to main content
Glama
Sign In
CLIranks

CLIranks

by alexanderclapp
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

get_api_docs

Retrieve agent-friendly API documentation with quickstart guide and endpoint details. Use before integrating an API to understand its interface and requirements.

Instructions

Get agent-friendly documentation for an API, including quickstart guide and documented endpoints. Use this before integrating an API.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "slug": "<slug>"
    },
    "name": "get_api_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
slugYesAPI slug, e.g. 'stripe-api', 'openai-api'

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A3.8/5.0
Behavior3/5

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

Without annotations, description minimally discloses what is returned (quickstart guide, documented endpoints). It does not discuss idempotency, caching, or side effects; but for a read operation, core behavior is conveyed.

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 concise sentences with purpose front-loaded. Every sentence adds value; no wasted words.

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?

Given the simple 1-param tool, no output schema, and no annotations, the description covers the essential purpose and content. Could mention output format, but completeness is adequate.

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 provides 100% coverage with a clear parameter description and example. Description adds no extra meaning beyond the schema, so baseline 3 is appropriate.

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?

Description clearly states the tool retrieves agent-friendly documentation for an API, including quickstart and endpoints. It distinguishes the tool from siblings like get_api_details by focusing on 'agent-friendly' docs, but does not explicitly differentiate.

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?

Explicit advice 'Use this before integrating an API' provides clear context. However, no mention of when not to use or alternatives to related tools like get_api_details.

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

Deploy Server

Other Tools