List every index topic in the active InDesign document, or choose an open document by name or 0-based index, to review or manage its index entries.
List all index topics in the active document
| Name | Required | Description | Default |
|---|---|---|---|
| document_id | No | Which open document to act on: a name (see document_listOpen) or a 0-based index. Defaults to the front document. |
Changes observed during successful MCP inspections.
v1.6.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full behavioral burden. 'List' implies a non-destructive read, but there is no disclosure of return shape, whether nested/sub-topics are included, ordering, or pagination for a document that may contain thousands of topics.
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?
A single tight sentence with the verb and resource front-loaded and zero waste. It is efficient, though brevity here shades into under-specification.
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?
Adequate for a simple no-required-param list tool with no output schema, but the description says 'active document' while the schema allows targeting any open document by name or index, leaving that capability unmentioned and the scope slightly muddled.
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?
Schema coverage is 100% and the single document_id parameter is fully documented in the schema (name, 0-based index, default to front document). The description adds nothing beyond that baseline, so a 3 is appropriate.
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?
Clear specific verb (List) plus resource (index topics) and scope (active document). It is distinguishable from index_createTopic/index_addEntry because the verb differs, but the description does not explicitly differentiate itself from them or relate to index_generate.
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?
No when-to-use guidance, no prerequisites, and no reference to the sibling tools index_addEntry, index_createTopic, or index_generate that operate on the same topic collection. The only contextual hint is the phrase 'active document'.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.