Skip to main content
Glama

create_api_test_credential

Store a reusable auth credential that API tests can use to reach a protected endpoint. Pick a type and fill the matching fields: BASIC (username+password), BEARER (token), API_KEY (apiKeyHeaders for header-placed keys and/or apiKeyQueryParams for query-string keys — at least one entry across the two), or OAUTH2_CLIENT_CREDENTIALS (tokenUrl+clientId+ clientSecret, optional scope/audience). The secret is write-only: the response returns only id, name and type — reference the returned id from an API test's httpCredentialId or mcpCredentialId.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesHuman-readable name for the credential, e.g. 'prod API key'
typeYesCredential type: BASIC, BEARER, API_KEY or OAUTH2_CLIENT_CREDENTIALS
scopeNoOAUTH2_CLIENT_CREDENTIALS only: requested scope
tokenNoBEARER only: the bearer token (secret, never returned)
audienceNoOAUTH2_CLIENT_CREDENTIALS only: requested audience
clientIdNoOAUTH2_CLIENT_CREDENTIALS only: client id
passwordNoBASIC only: password (secret, never returned)
tokenUrlNoOAUTH2_CLIENT_CREDENTIALS only: token endpoint URL
usernameNoBASIC only: username
clientSecretNoOAUTH2_CLIENT_CREDENTIALS only: client secret (secret, never returned)
apiKeyHeadersNoAPI_KEY only: keys sent as request HEADERS, as a map of header name -> value (values are secret, never returned). Combine with apiKeyQueryParams when some keys belong in the query string instead
apiKeyQueryParamsNoAPI_KEY only: keys sent as URL QUERY parameters, as a map of parameter name -> value (values are secret, never returned). Combine with apiKeyHeaders when some keys belong in headers instead

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the behavioral burden and discloses the most critical trait: 'The secret is write-only: the response returns only id, name and type.' It also reveals the type-conditioned validation expectations (e.g., 'at least one entry across the two' for API_KEY). It stops short of covering duplicate-name behavior or failure modes, but the key security-relevant behavior is transparent.

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, each earning its place: purpose, type-to-field mapping, and write-only response behavior. The dense second sentence is structured with clear type labels (BASIC, BEARER, API_KEY, OAUTH2_CLIENT_CREDENTIALS) that make the conditional logic scannable despite the length.

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?

Given 12 parameters, nested objects, no annotations, and no output schema, the description covers the essentials: purpose, conditional field requirements, response shape, and downstream usage via httpCredentialId/mcpCredentialId. Additional edge-case detail (duplicate names, limits) would be needed for a 5, but this is strong for the tool's complexity.

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 100%, so the baseline is 3, but the description adds real value by synthesizing the 12 parameters into a type-driven decision matrix (BASIC: username+password, BEARER: token, etc.) and highlighting conditional rules like the at-least-one API_KEY requirement and optional scope/audience. This goes beyond what the per-field schema descriptions provide.

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?

The description opens with a specific verb+resource: 'Store a reusable auth credential that API tests can use to reach a protected endpoint.' This clearly distinguishes the tool from siblings like create_api_test (creates the test) and delete_api_test_credential/list_api_test_credentials (lifecycle operations on existing credentials).

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?

The description establishes clear context: credentials are stored once and reused by API tests to reach protected endpoints, and the returned id plugs into an API test's httpCredentialId or mcpCredentialId. It does not explicitly name alternatives or exclusions, but the sibling set contains no competing credential-creation tool, so the usage context is effectively unambiguous.

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.

TDQS

A3.8/5.0
Disambiguation2/5

Several tool pairs are near-duplicates, including three deprecated aliases (add_investigation_alert_channel vs add_alert_channel, list_investigation_alert_channels vs list_alert_channels, remove_investigation_alert_channel vs remove_alert_channel) that muddy the surface. Additionally, suppress_signal and create_ignore_rule both suppress alerting via different mechanisms, which could cause misselection despite detailed descriptions.

Naming Consistency4/5

The vast majority of tools follow a clear verb_noun snake_case pattern (create_api_test, list_issues, set_alert_rule_status). A few bare-noun tools (logs, spans, metrics) and the standalone verb correlate break the pattern slightly, but overall the naming is highly consistent and predictable.

Tool Count1/5

With 52 tools, this is on the extreme end of the calibration scale. Even accounting for the broad scope of an observability platform, the count is excessive and includes several deprecated redundancies that inflate it further.

Completeness5/5

The toolset provides comprehensive CRUD/lifecycle coverage across all major domains: alert rules (create, read, update, delete, status, delivery, preview), API tests (create, read, update, delete, run history, credentials), ignore rules and suppressions, issues with digest config, investigations with claim/read, channels, credentials, and rich query tools (logs, spans, metrics, SQL, traces, correlation). No obvious dead ends or missing core operations.

Resources