deploy_to_workspace

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

No annotations are provided, so the description must carry the full burden of behavioral disclosure. The description says 'publish PBIP' and 'configure refresh' and 'initial refresh', but it does not disclose what the gate does when it fails (does it abort?), what happens to existing workspace content (overwrite or create new), whether configuration is destructive to existing refresh settings, or how authentication credentials are used. For a multi-step deployment tool with side effects, this is a significant gap.

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 declarative sentence that front-loads the core purpose (pre-deploy gate) and lists subsequent actions in order. No redundant words; every word earns its place. It is appropriately sized for a tool that orchestrates multiple sub-operations.

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 tool's complexity (10 parameters, multiple operations, no output schema details provided), the description is under-specified. It omits criteria for gate success/failure, dependencies among operations, cleanup behavior, and effect on existing workspace content. The existence of an output schema (though not shown) may clarify return values, but the description does not cover prerequisites, preconditions (e.g., PBIP exists, valid path), or behavior in mock mode. A 3 indicates room for improvement.

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%, so all parameters are undocumented in the schema. The description names 'PBIP' and 'refresh' but does not specify which parameters control the gate (e.g., 'gate_profile', 'findings_json'), the publish (e.g., 'pbip_path', 'workspace_id'), refresh configuration ('refresh_daily_hour'), or authentication ('client_id', 'tenant_id', 'client_secret', 'auth_mode'). The 'mock' parameter's purpose is not explained. The description does not compensate for the lack of schema descriptions, but the parameter names themselves are fairly self-explanatory, giving a baseline of 3.

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 lists four distinct actions: pre-deploy gate, publish PBIP, configure refresh, and initial refresh. Each is a specific verb plus resource, making the tool's purpose clear. It distinguishes from siblings like 'pre_deploy_check', 'run_refresh', and 'promote_in_pipeline' by combining these actions into a single orchestrating tool.

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 sequential actions imply a clear workflow: run the gate before publishing, configure refresh after publish. However, there is no explicit mention of when NOT to use this tool or when a sibling like 'pre_deploy_check' or 'run_refresh' should be used instead. The context signal of sibling tools suggests alternatives, but the description does not name them.

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