Skip to main content
Glama

get_doc

Read-onlyIdempotent

Fetch a full Scriptivox documentation page as markdown, by its slug (for example "quickstart", "authentication", "api-reference"). Call search_docs first if you do not know the slug. No API key required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe page slug, e.g. "quickstart". Use "" or "overview" for the documentation index.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already indicate a safe, read-only, idempotent operation. The description adds useful behavioral context: output is markdown, it returns the full page, and no authentication is needed.

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 compact sentences with no filler. The core action is front-loaded, followed by routing guidance and a short auth clarification.

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?

For a single-parameter read-only tool, the description covers the return format, how to find unknown slugs, index behavior via the schema, and authentication. Nothing essential is missing.

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?

The schema already documents slug at 100% coverage and even explains how to request the index. The description adds example slugs but does not materially expand beyond the schema.

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: fetches a full Scriptivox documentation page as markdown by slug. Examples and the explicit call-to-search_docs alternative distinguish it from the broader get_api_docs sibling.

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 call search_docs first when the slug is unknown, which is clear routing guidance. It also notes that no API key is required, removing a common prerequisite question.

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.