Skip to main content
Glama
brechanbech

xojo-mcp

by brechanbech
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Rust
Local

List Documentation Topics

list_doc_topics
Read-onlyIdempotent

Lists Xojo documentation pages by title and URL, optionally filtered, to identify which pages exist before searching text or reading a class.

Instructions

Lists the pages in the local Xojo documentation index, one title and URL per line. Unfiltered that is the whole index — about 1,600 entries, 150 KB — so pass a filter. An API page's title is the name lookup_class takes. No match is a normal result, not an error. Use this to find which pages exist; search_docs searches their text, and lookup_class reads one. Reads the installed documentation (fails if none was found) and needs no IDE.

Input Schema

NameRequiredDescriptionDefault
filterNoCase-insensitive substring matched against each title and URL (e.g. 'Desktop', 'database'), so 'desktop' also matches every page under a /desktop/ path. Omit to list the whole index.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv3.7.1
    • changedInput schema / properties / filter / description
      Previous value: -"Keyword to filter topics (e.g. 'Desktop', 'database'). Returns all if empty."New value: +"Case-insensitive substring matched against each title and URL (e.g. 'Desktop', 'database'), so 'desktop' also matches every page under a /desktop/ path. Omit to list the whole index."
  2. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already mark this as read-only, idempotent, non-destructive, and not open-world. The description adds important behavioral context beyond that: unfiltered output is about 1,600 entries and 150 KB, it fails if installed documentation was not found, and it needs no IDE.

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 compact and front-loaded: it states what the tool returns, then scale and filter guidance, then sibling-tool routing. Every sentence contributes relevant information without waste.

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?

There is no output schema, but the description explains the return shape as one title and URL per line. It also covers scale, failure conditions, IDE independence, empty-result semantics, and alternatives, which is complete for a simple one-parameter listing tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema already documents the single filter parameter at 100% coverage, including its case-insensitive substring behavior. The description adds useful practical meaning by warning that unfiltered output is very large and therefore the caller should pass a filter, plus it clarifies the relationship between API page titles and lookup_class.

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?

States a specific verb and resource: it lists pages in the local Xojo documentation index, one title and URL per line. It also distinguishes itself from sibling tools by explaining that search_docs searches page text and lookup_class reads one page.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says to use this tool to find which pages exist, names the alternatives search_docs and lookup_class, and gives a clear condition for using the filter. It also notes that no match is a normal result, which prevents misinterpreting an empty list as failure.

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