workspace_read

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive behavior, and openWorldHint. The description adds useful prerequisites for log and log_timeline, but it does not discuss pagination, output size behavior, or other operational constraints beyond what annotations and schema already imply.

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 front-loaded with the overall purpose and then enumerates actions compactly using pipes. It is dense but efficient for a multi-action tool, with only minor awkwardness in the action-list formatting.

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 absence of an output schema, the description still names what each action returns at a high level: recent logs, one full log entry, a message timeline, credit balance, and plan quota. It leaves some filter and pagination details to the schema, but it is complete enough for action selection and basic invocation.

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 description helps map actions to required parameters, notably logId for log and traceId for log_timeline. With 64% schema description coverage, it adds some meaning beyond the schema, but it does not explain page, search, status, or the full set of filters for logs.

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 a specific verb, resource, and action set: read workspace-level activity/webhook logs, credit balance, and quota. It is clear what the tool does, but it does not explicitly distinguish itself from adjacent read tools such as usage_read or get_agent_audit_log.

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?

It gives a useful usage context for logs—debugging why 'the bot did not reply'—and maps each action to its purpose. However, it does not say when to choose this tool over similar siblings or when not to use it.

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