Skip to main content
Glama

Velvet Developer Docs

Read a Velvet docs page

get_doc
Read-only

One whole page of the Velvet developer docs as Markdown (the same text as /docs/.md). Pages: quickstart (Quickstart), keys (Keys), sdk (SDK reference), tracks (Sync to video and audio), safety (Safety), browser-support (Browser and platform support), intiface (Use Velvet toys with Intiface), live/quickstart (Velvet Live quickstart), live/server-api (Server API), live/live-js (live.js), live/menu (The tip menu), live/errors (Errors), live/embedding (Iframe & browsers), ai-tools (Use with AI tools), changelog (Changelog).

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": {
      "page": "<page>"
    },
    "name": "get_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageYesThe page, e.g. "quickstart" or "live/server-api"

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already establish readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds genuinely new behavioral context by specifying the return format (Markdown) and that the content mirrors /docs/<page>.md, which matters since there is no output schema. It does not mention error behavior or caching, but those are minor here.

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

Conciseness4/5

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

The core statement is front-loaded in the first clause, and the page enumeration is dense but scannable. The parenthetical labels duplicate enum values already in the schema, adding some redundancy, but the text remains short and purposeful.

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?

For a one-parameter read tool with no output schema, the description covers what is returned (full page as Markdown) and what inputs are valid (all 15 pages). Missing only minor operational details such as error handling for an invalid page, which the enum largely prevents.

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 coverage is 100% and the single parameter is a fully enumerated enum, so the schema already carries the semantics. The description does add human-readable labels for each enum value (e.g., 'live/menu (The tip menu)'), which slightly helps selection, but this largely restates the enum.

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?

The description states a specific action and resource: it returns 'One whole page of the Velvet developer docs as Markdown', and ties it to a concrete source ('the same text as /docs/<page>.md'). The phrase 'One whole page' implicitly contrasts with a snippet/search tool, but no sibling such as search_docs is named, so differentiation is left to inference.

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?

Usage is only implied: an agent can infer this is the tool for fetching a complete documentation page rather than searching. There is no explicit statement of when to prefer it over search_docs, no exclusion for partial/query-based lookups, and no prerequisites mentioned.

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