promote_document

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

With no annotations, description discloses default copy behavior, auto-detection of project with fallback to inbox, and optional move. Lacks details on error handling or return value, but covers key behavioral traits.

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?

Three sentences with leading purpose statement. Every sentence conveys essential information without redundancy or verbosity.

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?

Covers purpose, usage, parameter behavior, and fallback. Lacks output specification (e.g., success message) but is adequate for a simple import tool without output schema.

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% with descriptions for all three parameters. Description adds context about auto-detection and copy/move but does not significantly enhance parameter meaning beyond the schema.

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?

Clearly states the action 'promote' and the resource 'document from external vault into alcove doc-repo'. Distinguishes from sibling tools like get_doc_file or search by focusing on importing external files.

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?

Explicitly says 'Use this tool when the user wants to import, migrate, or copy a file from outside alcove'. Provides context on auto-detection and copy/move behavior, but does not mention when not to use or list alternative tools.

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