Inspect Source

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

The description uses 'Inspect' and 'preview,' which imply read-only behavior, but the annotations indicate destructiveHint=true and readOnlyHint=false. This is a direct contradiction, making the tool's behavior unclear and potentially misleading.

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 minimal but not concise in an effective way. It omits crucial details about parameters, behavior, and side effects, making it under-specified rather than appropriately sized.

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?

With no output schema and no parameter explanations, the description lacks essential context. It does not mention the tool's purpose beyond a vague inspection, nor does it address potential destructive actions indicated by the annotations.

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 description provides no explanation of the two parameters (workspaceSlug and requestBody) or the nested 'source' object with its oneOf variants. It fails to clarify the meaning of fields like repoUrl, uploadId, or catalog name, leaving users to guess the required inputs.

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 'Inspect a source and preview its template' is vague. 'Source' could refer to a git repository, upload, or catalog, and 'template' is undefined. It lacks a clear resource and specific verb that distinguishes it from sibling tools like listTemplates or getWorkspace.

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 alternatives. The description does not mention any conditions, prerequisites, or comparisons to sibling tools such as listTemplates or deployApp.

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