Search Dokploy API

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint. The description adds behavioral context by detailing the return types (procedure names, parameters, schemas, etc.) and emphasizing that 'catalog' is a global. No contradictions.

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 front-loaded with the critical usage note about not wrapping in a function. It then provides structured examples. While slightly lengthy, every sentence adds value, and the structure is logical.

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?

Despite having no output schema, the description explains what the tool returns in sufficient detail (procedure names, parameters, HTTP methods, etc.). It covers the core functionality and usage patterns comprehensively.

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%. The description adds significant value by explaining that 'code' is JavaScript code with examples, and that 'profile' is optional for validation. This goes beyond the schema's basic descriptions.

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 specifies the verb 'Search' and the resource 'Dokploy API catalog'. It effectively distinguishes itself from sibling tools 'execute' and 'list_profiles' by focusing on catalog exploration rather than execution or profile listing.

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?

Provides extensive usage guidelines with concrete code examples and common patterns. It explains how to use different methods and what each returns. However, it lacks explicit contrast with sibling tools or clear 'when not to use' statements, preventing a top score.

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