Skip to main content
Glama

Search GPUI Kit docs

search_docs
Read-only

Search GPUI Kit documentation by keyword to locate matching guides and component reference pages, returning titles, paths, descriptions, and snippets for follow-up reading.

Instructions

Full-text search across all GPUI Kit documentation (guides, gpui-base primitives, components, gpui-shell). Returns matching pages with title, path, description and a content snippet. Start here, then call get_doc with the returned path.

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": {
      "query": "<query>"
    },
    "name": "search_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoDocumentation language: "all" (default, auto-prefers the query language), "en", or "zh" (zh-CN).
limitNoMaximum results (default 8, max 25).
queryYesSearch keywords, e.g. "button loading", "focus trap", "data table", "按钮".
sectionNoRestrict to a section: "docs", "base", "component", "shell", or a path prefix such as "base/primitives".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds value by disclosing the fields each hit contains even though no output schema exists. It omits ranking order and empty-result behavior, which keeps it from a 5.

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?

Three short sentences: scope first, return shape second, next step third. No filler, and the most decision-relevant information is front-loaded.

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 read-only search tool with a fully documented four-parameter schema and no output schema, the description supplies the missing pieces an agent needs: what corpora are searched, what a hit looks like, and how to continue to get_doc.

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 query, limit, lang, and section are all documented in the schema, including enum values and defaults. The description adds no meaning beyond that, so the baseline 3 applies.

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 names a specific verb (full-text search) and resource (all GPUI Kit documentation), enumerates the covered corpora (guides, gpui-base primitives, components, gpui-shell), and states the return shape (title, path, description, snippet). An agent can distinguish it from list_docs/get_docs_index without opening any schema.

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?

"Start here, then call get_doc with the returned path" gives explicit entry-point guidance and a concrete follow-up routed to a named sibling. It stops short of saying when NOT to use it (e.g., enumerating sections via list_docs or get_docs_index), so it is clear context rather than full when/when-not coverage.

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