explain_workflow

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

No annotations are provided, so the description carries the full behavioral burden. It indicates the tool returns step-by-step explanations, but does not disclose return format, depth, limitations, or whether it performs any side effects. For a read-only retrieval tool this is lower risk, but the description remains sparse.

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, front-loaded sentence with no wasted words. Its brevity is appropriate for a simple one-parameter tool, though it leaves out useful routing context.

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 description is minimally complete: it says what the tool returns and the schema documents the input. However, with no annotations and no output schema, it could do more to clarify scope, return format, and how it differs from sibling documentation tools.

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 100%, so the schema already fully documents the single workflow parameter, including fuzzy matching and example inputs. The description adds no additional parameter meaning beyond what the schema provides, which meets the baseline 3 for high schema coverage.

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 and resource: 'Get step-by-step explanation of common Orderly development workflows.' It clearly conveys the tool returns explanatory workflow guidance, but it does not explicitly differentiate itself from siblings such as search_orderly_docs or get_component_guide.

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?

There is no guidance on when to use this tool versus search_orderly_docs, get_component_guide, or the various API info tools. The description implies it is for workflow explanations, but an agent must infer the selection criteria.

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