rh_export_workflow

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

With no annotations, the description carries the full behavioral burden. It does add real value by disclosing that the export is local (no network/cloud submission) and that secrets are stripped, which implies a safe read. It stops short of stating read-only semantics explicitly, error behavior, or what the exported payload surface looks like.

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?

A single front-loaded sentence with no filler; every clause (local, revision, API JSON, no secrets, no cloud) carries 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?

Given no output schema and no annotations, the definition is only partially complete: it never says whether output is returned inline or written to a file, nor how it behaves for non-local/cloud workflows. The omitted revision_id/when-to-use guidance leaves real gaps for a 3-parameter tool.

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 description coverage is 0% for three parameters, so the description must compensate but adds almost nothing: it never explains the workflow_id vs revision_id distinction or whether revision_id is optional (defaulting to latest). Only 'format' is self-documenting via its const/enum.

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?

States a specific verb (Export) and resource (local workflow revision) and pins the output format (API-format JSON). The qualifiers 'local' and 'without cloud submission' cleanly separate it from the inverse sibling rh_import_workflow and from cloud-side reads like rh_get_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?

No statement of when to choose this over rh_get_workflow, rh_import_workflow, or rh_validate_workflow, and no prerequisites or exclusions. The agent must infer the use case from the phrase 'local workflow revision' alone.

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