Skip to main content
Glama

vault_deposit

Store an API key, token, or password encrypted in Commons so other agents can use it through use_credential without seeing it.

Instructions

Hand over an API key, token or password you hold so Commons keeps it (encrypted) and other agents can use it through use_credential without seeing it. Deposit it the moment you get it. A new key needs purpose (what it is for) and scope (what it can do at the provider: read-only, DNS edit on one zone, full admin; 'unknown' if the provider doesn't say); used_in = every place it is installed or used: [{"where": "Poise server (LXC 108) .env", "what": "sends sign-in codes", "project": "Poise"}], or add them later with vault_note. base_urls (where it may be sent) can wait: until vault_hosts sets them the key is never sent anywhere. auth = bearer | basic:USER | header:NAME | header:NAME:PREFIX | query:PARAM; risk = low | normal | high (high: every write asks the user). You can add new keys and update your own, not replace another's.

Input Schema

NameRequiredDescriptionDefault
authNobearer
nameYes
riskNonormal
agentNo
scopeNo
valueYes
api_keyNo
purposeNo
serviceYes
used_inNo
base_urlsNo
descriptionNo
extra_headersNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.36.1

TDQS

A4.7/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so richly: encryption at rest, that other agents use the key without seeing it, the auth encoding formats, the risk enum's behavioral consequence ('high: every write asks the user'), and the deferred-send semantics of base_urls. This is exactly the behavioral context annotations would otherwise supply.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The purpose leads the paragraph, then parameter guidance follows in a logical order. It is dense and parenthetical-heavy, but for a 13-parameter tool most sentences earn their place; a few could be broken into clearer structure.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 13-param mutation tool with no annotations and no output schema, the description covers purpose, usage, permissions, and most parameters. Remaining gaps are minor parameter definitions (agent, api_key, extra_headers) and any indication of what a successful deposit returns, but the agent has enough to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% across 13 params, so the description must compensate, and it explains the non-obvious ones well: purpose, scope (with provider-level examples), used_in (with a concrete object shape), base_urls, auth (with the full bearer|basic|header|query grammar), and risk. It omits meaning for agent, api_key, extra_headers and description, which is the only reason this isn't a 5.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ('Hand over an API key, token or password ... so Commons keeps it (encrypted)') and immediately distinguishes the resource from its sibling by naming use_credential as the consumption path. An agent knows this is the deposit side of a credential store without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly instructs when to act ('Deposit it the moment you get it') and routes to alternatives for deferred work ('or add them later with vault_note', 'until vault_hosts sets them the key is never sent anywhere'). It also states the permission boundary ('You can add new keys and update your own, not replace another's'), so the agent knows when this tool will and won't work.

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