Skip to main content
Glama

Read a GPUI Kit doc page

get_doc
Read-only

Read GPUI Kit documentation pages as Markdown by path, title, or slug, and return only the requested section to keep context small.

Instructions

Read a GPUI Kit documentation page as Markdown. Accepts a path from search_docs (for example /component/button.md) or a page title/slug such as "Button". Use section to return only one heading's content on long pages. When a title matches several pages, the available paths are returned so you can choose.

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

Input Schema

NameRequiredDescriptionDefault
langNoDocumentation language: "all" (default, auto-prefers the query language), "en", or "zh" (zh-CN).
pathYesPage path ("/component/button.md"), URL, or title/slug ("Button").
sectionNoReturn only the section whose heading contains this text, e.g. "Usage" or "Variants".
maxCharsNoMaximum characters of page body to return (default 24000).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare this as a read-only, closed-world operation, and the description adds useful behavior: output is Markdown, section filtering returns only one heading's content, and ambiguous titles return available paths. It does not describe truncation behavior around maxChars, which keeps it from being fully transparent.

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?

The description is front-loaded with the core action and output format, then moves to accepted inputs, section filtering, and ambiguity handling. Every sentence adds useful information without repetition.

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?

There is no output schema, so the description appropriately explains that the page is returned as Markdown and describes section and ambiguous-title behavior. It leaves maxChars truncation and lang behavior to the schema, which is acceptable but not fully complete for a no-output-schema tool.

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 description coverage is 100%, so the schema already documents all four parameters. The description adds some meaning about path sourcing from search_docs and section usage, but it does not add details for lang or maxChars beyond what the schema provides.

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?

The description starts with a specific verb and resource: "Read a GPUI Kit documentation page as Markdown." It also names search_docs as the source of a path, which distinguishes this page-reading tool from the search sibling.

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?

It explains that callers can pass a path from search_docs or a title/slug, and it says to use section to isolate one heading on long pages. It does not explicitly cover when to use list_docs or get_docs_index instead, but the main usage context is clear.

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