list_workspace_documents

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

No annotations provided, so description must communicate behavior. It states 'List all documents' but omits whether the operation is read-only, returns full documents or metadata, or has pagination. Minimal disclosure.

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 short sentence with no superfluous detail, but it is too sparse to be useful. Adequate length for the content, but lacks necessary information.

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 and no annotations, the description should clarify return type, behavior, or limitations. It provides none, leaving the agent uncertain about the tool's output or side effects.

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 single parameter 'slug' has 0% schema description coverage. The description does not explain what 'slug' represents (likely workspace identifier), adding no value beyond the schema.

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 states 'List all documents in a workspace', which clearly indicates a verb (list) and resource (documents in a workspace). It distinguishes from sibling tools like list_threads or list_workspaces, but doesn't specify the workspace identifier scope.

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 guidance on when to use this tool versus alternatives. Sibling tools include list_threads, list_workspaces, and chat, but no contextual hints about selecting this tool for document listing.

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