Skip to main content
Glama
Sign In
StitchAPI Docs

StitchAPI Docs

by rejifald
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

get_doc

Retrieve the full StitchAPI documentation page in Markdown format using a URL or slug. Use this tool to get complete documentation after finding a relevant snippet via search.

Instructions

Fetch a full StitchAPI documentation page as Markdown — the "read the whole thing" escape hatch for a search_docs hit. Pass a url (as returned by search_docs) or a slug like "guides/resilience/throttle".

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoPage URL from search_docs (absolute or /docs/…).
slugNoPage slug, e.g. "guides/resilience/throttle".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior3/5

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

No annotations exist, so the description must carry the transparency burden. It discloses the return format (Markdown) and that it fetches the full page, but doesn't mention authentication, rate limits, or error cases. Adequate but not exhaustive.

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 that front-load the core purpose and follow with concise usage instructions. Every word earns its place with no redundancy.

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?

Given the tool's simplicity (2 optional string params, no output schema), the description fully covers purpose, usage, parameter options, and return format. No gaps remain for this level of complexity.

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 description adds context beyond the input schema by specifying that 'url' should come from search_docs and giving a concrete example for 'slug'. Schema coverage is 100%, so baseline is 3; the added info earns a 4.

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?

Clearly states it fetches a full StitchAPI documentation page as Markdown and distinguishes itself from the sibling tool search_docs by calling itself the 'escape hatch for a search_docs hit'.

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?

Explicitly instructs the agent to use this tool after a search_docs hit, and tells how to pass the URL or slug. This provides clear when-to-use guidance relative to the sibling.

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