get_workflow_schema

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

No annotations are provided, so the description carries the full burden. It states the HTTP method (GET), implying a read-only operation, but does not disclose error handling, authentication requirements, or the structure of the response beyond naming the contents (fields and example payloads). 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 sentence that leads with the action ('Fetch'), names the resource ('workflow'), and immediately provides the endpoint. Every word earns its place; there is no padding or repetition.

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?

The tool is simple (one required parameter, safe read operation) and an output schema exists, reducing the need to describe return formats. However, the description omits usage context and parameter semantics, leaving the agent without enough information to invoke it confidently in the right situations. It is minimally complete but has clear gaps.

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 input schema has 0% description coverage and the description adds little detail about the 'workflow' parameter. It appears in the URL pattern ({workflow}) but the description does not clarify whether it is an ID, name, or path. No additional semantics are provided to compensate for the schema's lack of explanation.

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 clearly states the tool's function: fetching required fields, optional fields, and example payloads for a workflow. It includes the HTTP endpoint (GET /v1/workflows/{workflow}/schema), which makes the resource and action unambiguous. This distinguishes it from siblings like validate_workflow_payload or score_workflow.

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. It does not mention use cases such as inspecting a workflow before sending payloads or constructing requests, nor does it exclude scenarios like validation or scoring. The only context is the tool's own purpose, leaving the agent to infer applicability.

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