Get walt.id llms.txt index
get_waltid_llms_indexReturn the llms.txt index of public documentation pages. This is the index, not the full text of every page.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
get_waltid_llms_indexReturn the llms.txt index of public documentation pages. This is the index, not the full text of every page.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so the safety profile is covered. The description adds genuine context beyond that by clarifying the returned content is an index of pages rather than page bodies, which sets the right expectation about result size and shape; it stops short of describing entry format or pagination.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two short sentences, zero filler, with the key disambiguation ('the index, not the full text') front-loaded in the second sentence. Nothing could be removed without losing meaning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no output schema, the description carries the burden of explaining what comes back; it says only that it is an index, without indicating the entry format (links, titles) or the natural next step of fetching a page with get_waltid_doc_page. Adequate for a trivial no-argument tool, but there is an unaddressed gap around return shape.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters and the schema is fully described, so there is nothing for the description to compensate for. Baseline for a 0-param tool applies, with no misleading parameter claims.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description gives a specific verb ('Return') and resource ('the llms.txt index of public documentation pages'), and it explicitly delimits scope with 'This is the index, not the full text of every page'. That contrast implicitly separates it from get_waltid_doc_page, though no sibling tool is named directly, which keeps it short of a 5.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Use as a discovery/entry point is implied by calling it an 'index', but there is no explicit when-to-use statement, no exclusion ('do not use this if you already know the page'), and no pointer to get_waltid_doc_page or search_waltid_docs as follow-ups. The agent must infer the routing from the sibling names.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.