Skip to main content
Glama

List BYOK API key pool

list_byok_keys
Read-onlyIdempotent

Retrieve metadata of all BYOK API keys for a project, grouped by provider. View label, priority, status, and cooldown to identify active or exhausted keys.

Instructions

List all BYOK API keys for the project, grouped by provider. Shows label, priority, status, and cooldown. Never returns the raw key value — only metadata. Use this to see which keys are active or exhausted.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYesProject id
Behavior4/5

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

Description adds key insight that raw key value is never returned, only metadata. Annotations already declare readOnlyHint and idempotentHint, so the description complements without contradiction.

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: purpose, output contents and constraints, usage guidance. No wasted words, front-loaded essential information.

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

Completeness5/5

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

For a simple read-only list tool with one parameter and no output schema, the description covers purpose, output shape, key behavioral constraint, and usage context completely.

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 coverage is 100% with a clear description for the single parameter. Description does not add extra parameter details, but baseline is acceptable given coverage.

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?

Clear verb 'list' plus specific resource 'BYOK API keys for the project, grouped by provider' with explicit output fields. Distinguishes from sibling 'add_byok_key' which is a write operation.

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

Usage Guidelines4/5

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

States 'Use this to see which keys are active or exhausted', giving a clear when-to-use. Does not explicitly mention alternatives, but siblings make the differentiation obvious.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/kensaurus/mushi-mushi'

If you have feedback or need assistance with the MCP directory API, please join our Discord server