akb_create_vault

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

With no annotations, the description bears full responsibility for behavioral disclosure. It correctly states that the vault is access-controlled and that using external_git creates a read-only mirror that tracks a remote on a polling schedule and rejects user writes. This adds meaningful behavioral context beyond just 'create'.

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?

Two sentences with no waste. The first sentence defines the main purpose, and the second explains the alternative behavior. Every phrase earns its place.

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?

The description covers the core functionality well, but misses some details: no mention of return values (e.g., vault ID) or potential failure modes. For a creation tool with no output schema, a bit more about what to expect after invocation would improve completeness.

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?

All 5 parameters have schema descriptions (100% coverage), so baseline is 3. The description adds extra value by explaining the interaction between parameters: e.g., template is ignored when external_git is set, and external_git overrides normal behavior. This clarifies conditional logic 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?

The description clearly states the tool creates a new knowledge base vault and distinguishes the special case of creating a read-only mirror via external_git. Among sibling tools like akb_archive_vault, akb_list_vaults, etc., the purpose is specific and unambiguous.

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 provides clear guidance on when to use the tool (create a vault) and explains the conditional usage of external_git for a read-only mirror. It does not explicitly state alternatives for other vault-related operations, but the context from sibling tool names implies such distinctions.

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