Skip to main content
Glama

fields_list

Read-only

List every field in a Word .docx by story, with address, instruction code, type, result text, and stale status; filter by field type or story.

Instructions

Every field of the document, by story: its address, instruction code, type (PAGE, TOC, REF, ADDIN ZOTERO_ITEM, CITATION, ...), result text and whether the result is stale. Covers complex fields (also nested, or split across runs), simple fields and fields in text boxes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docYesPath to the .docx.
typeNoOnly fields of this type, e.g. "TOC" or "ADDIN ZOTERO_ITEM".
storiesNoStories to read (default all): "body", "notes", "headers" and "comments".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.5/5.0
Behavior4/5

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

readOnlyHint=true already covers the safety profile, and the description adds real context: it discloses scope guarantees (complex fields, nested fields, fields split across runs, simple fields, text boxes) and a computed output ('whether the result is stale'). It doesn't cover performance, ordering, or error behavior, but for a read-only list this is meaningful added detail.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences with the resource front-loaded and no filler. The parenthetical enumerations are dense but each earns its place by clarifying coverage.

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?

With no output schema, the description carries the return-value burden and does so by naming the returned attributes including the computed staleness flag. Combined with a fully-covered parameter schema and read-only annotation, it is nearly complete; only usage routing is missing.

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 all three parameters are already documented. The description reinforces 'by story' and gives field-type examples (TOC, ADDIN ZOTERO_ITEM, CITATION) that align with the type filter, but adds no syntax or defaults beyond what the schema 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+resource ('list every field of the document') and enumerates what is returned (address, instruction code, type, result text, staleness). It distinguishes itself from the sibling fields_update by describing a read/dump, though it never names an alternative explicitly.

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

Usage Guidelines2/5

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

There is no when-to-use statement, no prerequisites, and no mention of the obvious alternative fields_update. The usage is only implied by the word 'list', so an agent must infer the context itself.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.