List Document Properties

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safe read-only nature is established. The description adds useful context by specifying that it lists both workspace definitions and document values, but it does not disclose behavior like how workspaceId is handled when omitted, error conditions, or pagination. This is adequate but not rich.

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?

The description is a single, focused sentence with no redundancy. It front-loads the action 'List' and immediately clarifies the scope, making it efficient and scannable.

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?

Given the simple read-only nature, output schema presence, and clear annotations, the description is mostly adequate. However, with 0% parameter schema coverage and no usage guidance, it falls short of fully enabling autonomous correct invocation, especially regarding optional workspaceId behavior.

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 0%, so the description must compensate. It references 'workspace' and 'document,' which maps to workspaceId and docId, but it does not explicitly define each parameter's role, whether workspaceId is optional, or how the parameters interact. This leaves ambiguity for the agent.

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 uses a specific verb ('List') and clearly identifies the resources: 'workspace custom-property definitions' and 'a document's current values for them.' This distinguishes it from sibling tools like create_custom_property, set_doc_property, and clear_doc_property, which modify properties rather than list them.

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?

The description provides no guidance on when to use this tool versus alternatives such as set_doc_property or list_custom_properties. It does not mention prerequisites, exclusions, or scenarios where this tool is preferred over sibling tools.

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