push_workspace

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

Annotations already indicate destructiveHint=true. The description adds value by mentioning the backup creation behavior and the version name constraints (max 15 chars, allowed characters). However, it does not disclose default behavior of the prune parameter (which deletes remote files) or other side effects, leaving gaps in full transparency.

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 composed of two sentences, with the primary action in the first sentence and a key constraint in the second. It is concise, front-loaded, and contains no unnecessary words.

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?

For a tool with 6 parameters (3 required), a destructive hint, and no output schema, the description is incomplete. It omits details about the prune parameter's default (true), guidance on choosing between workspaceName and workspaceId, the environment parameter, and return value information. These gaps make it insufficient for fully informed use.

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 100%, so each parameter is already documented. The description reinforces the constraint on 'message' (max 15 chars, specific characters) but does not add meaning to other parameters beyond their schema descriptions. Overall, it provides marginal additional value.

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 verb 'Upload' and the resource 'local workspace directory to Prisme.ai', and adds the distinctive action 'Creates a backup version before importing'. This distinguishes it from sibling tools like pull_workspace.

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 implies usage when uploading local workspace content to Prisme.ai, but it does not explicitly state when to use this tool versus alternatives like push_workspace_version or pull_workspace. No exclusion criteria or alternative suggestions are provided.

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