Skip to main content
Glama

Get GPUI Kit llms.txt index

get_docs_index
Read-only

Retrieve the GPUI Kit documentation index with page paths and one-line summaries, filtered by language or section to locate relevant docs while keeping responses small.

Instructions

Return the collected https://gpui-kit.com/llms.txt index: every documentation page with its path and one-line description. Filter by language or section to keep the response small.

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_docs_index"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoDocumentation language: "all" (default, auto-prefers the query language), "en", or "zh" (zh-CN).
sectionNoFilter by section: "docs", "base", "component", "shell", or a path prefix.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds that the response is the full index and that filtering shrinks it, but says nothing about response size limits, truncation, or ordering for an unfiltered call.

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, zero filler, with the core return value stated first and the filtering advice second. Nothing is repeated or padded.

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 simple two-optional-parameter read tool with full schema coverage and annotations covering safety, the description supplies what is needed: what comes back (paths plus one-line descriptions) and how to narrow it. Only the absence of any note on response size or ordering keeps it from being fully complete.

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 both lang and section are already documented in the schema, including the enum values and the 'all' default behavior. The description only restates the filtering purpose, adding no syntax or format detail beyond the schema, which is the baseline-3 case.

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 names a specific verb and resource: it returns the collected llms.txt index, enumerating every documentation page with its path and one-line description. That is concrete enough to distinguish it from a single-document fetch or a search, though it never explicitly contrasts itself with get_doc, list_docs, or search_docs.

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?

It gives one piece of operational advice — filter by language or section to keep the response small — which implies this is the broad enumeration tool. It does not state when an agent should prefer search_docs or get_doc instead, so the routing decision is left to inference.

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