Skip to main content
Glama

List GPUI Kit docs

list_docs
Read-only

Browse GPUI Kit documentation pages with optional language, section, and keyword filters to locate the right guide or component reference before reading.

Instructions

List GPUI Kit documentation pages, optionally filtered by language, section, or a keyword matched against title and description. Useful for browsing what is available before reading a page.

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": "list_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoDocumentation language: "all" (default, auto-prefers the query language), "en", or "zh" (zh-CN).
limitNoMaximum pages to list (default 100).
queryNoOptional keyword matched against page titles and descriptions.
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 matching occurs against titles and descriptions, but says nothing about result ordering, default page size behavior, or what a listing entry contains.

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 tight sentences, front-loading the core action and filters before the usage note. No filler, no repetition of defaults or limits.

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 zero-required-parameter read-only listing tool with fully documented schema and annotations, the description covers what is needed to invoke it. The one real gap is routing versus the overlapping search_docs sibling, which shares a keyword-query capability.

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%, so every parameter including enum values, default, and maximum is already documented in the schema. The description largely restates the same filter set and adds only the detail that the keyword targets titles and descriptions, which the schema also states.

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?

States a specific verb and resource: 'List GPUI Kit documentation pages', plus the three optional filter dimensions. The phrase 'before reading a page' hints at the get_doc sibling, but search_docs and get_docs_index are never named or differentiated.

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?

'Useful for browsing what is available before reading a page' gives a browsing context, so usage is more than implied. However, no exclusion or comparison is offered against search_docs, which also takes a free-text query and could clearly be confused with this tool.

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