Skip to main content
Glama

Read through an authorized API-key connection

vault_invoke_read
Read-onlyIdempotent

Read data through an authorized API-key/PAT connection using a GET request. API Vault controls authentication and destination hosts and injects the stored credential server-side; credentials are never returned. Use vault_invoke_write for any operation that sends data or changes provider state.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "connection_id": "<connection_id>",
      "path": "<path>"
    },
    "name": "vault_invoke_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
headersNo
operationNoapi.request
credentialNoFor owner-bound custom APIs only. API Vault chooses Bearer by default; set this only when the provider docs require a custom header or query parameter. The stored key is still injected server-side and never returned.
connection_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/openWorld, and the description adds genuinely new behavior: API Vault controls authentication and destination hosts, injects the stored credential server-side, and never returns credentials. It does not mention rate limits or error behavior, so it stops short of 5.

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

Conciseness5/5

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

Three sentences, front-loaded with the action and transport, followed by the security model and then the sibling routing. No filler.

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

Completeness3/5

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

The auth/destination model is well covered, which matters most for an openWorld tool, but with no output schema and only 20% parameter coverage the description leaves the response shape and the meaning of path/headers/operation unexplained.

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

Parameters3/5

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

Schema description coverage is only 20%, so the description must compensate; it explains the credential handling model (server-side injection, credential object only for owner-bound custom APIs) but says nothing about path, headers, or operation semantics. It adds useful framing for one parameter family while leaving the rest to an under-described schema.

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 (read), resource (data through an authorized API-key/PAT connection) and the transport (GET request), which is precise enough to distinguish it from a write-style operation at a glance.

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 routes the agent: this tool for reads, vault_invoke_write for anything that sends data or changes provider state. That is a clear when/when-not split with a named alternative.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources