lattice_reveal_database_credentials

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

Without annotations, the description fully discloses behavioral traits: calls are audited, passwords are masked to first two characters by default, and real values require an environment variable LATTICE_ALLOW_SECRET_VALUES=1 or reading from the UI. This exceeds expectations for transparency.

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 paragraph but efficiently packs multiple pieces of information: what it does, audit behavior, default return, guidance on include_root, and masking details. It is not overly long, though it could be slightly more structured.

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 no output schema, the description adequately explains what to expect (application user, masked passwords, need for env var to get real values) and mentions audit logging. It could mention error cases like invalid ID, but for a credential-revealing tool, it is sufficiently complete.

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 input schema already describes both parameters (id and include_root) with 100% coverage. The description adds meaningful context: it clarifies that include_root defaults to false and should only be used when needed, and explains that passwords are masked. This adds value 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's purpose with specific verb 'Reveal' and resource 'database instance's live credentials'. It distinguishes from sibling tools like lattice_get_database_credentials by highlighting that every call is audited and what credentials are returned (application user by default, root optional).

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 explicit guidance on when to use include_root ('only when root access is genuinely required') and notes that calls are audited. However, it does not directly compare with the similar sibling tool lattice_get_database_credentials, which could help the agent choose between them.

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