Metadata Scan

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

No annotations are provided, so the description carries full responsibility for explaining behavior. It mentions 'scan' which implies a read-only operation, but it does not explicitly state that it does not modify or download anything. It also does not describe any side effects, required permissions, or what happens if metadata is missing. Given the tool's low complexity, a brief note on non-destructiveness would have been sufficient.

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 sentence, front-loaded with the action and resource, and includes the API endpoint for reference. It is concise with no filler or redundancy.

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 simplicity (no parameters, no output schema), the description is adequate for basic understanding. However, it could be more complete by explicitly noting that the operation is read-only and describing what the output is (e.g., a list of detected metadata). Since there is no output schema, the description could have filled that gap. But for a simple scan tool, it is acceptable.

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 tool has zero parameters, and the schema is empty. The description correctly indicates that the tool operates on local files without requiring additional input. This is effectively a baseline for a no-parameter tool, and the description provides clarity on what it does without any parameter ambiguity.

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 action (scan), the object (local model files), and the goal (match CivitAI metadata). It also references the underlying API endpoint, which adds specificity. Although it doesn't explicitly differentiate from siblings, the verb 'scan' and the reference to 'metadata' make it distinct from related tools like 'sdnext_civitai_metadata_update' (which implies a write operation) and 'sdnext_civitai_check_local' (likely a different check).

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 the tool is used for scanning local model files to match CivitAI metadata, but does not explicitly state when to use it versus alternatives like 'sdnext_civitai_check_local' or 'sdnext_civitai_metadata_update'. There are no exclusions or alternative tool references, leaving some ambiguity for an agent deciding between similar tools.

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