Skip to main content
Glama

Validate credential name

validate_credential_name
Read-only

Check whether a credential name is valid and free to use in the organisation. Returns the validation verdict, the RFC1035-normalised form, and any conflicting existing credential. Read-only.

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": {
      "credential_name": "<credential_name>"
    },
    "name": "validate_credential_name"
  }
}

Input Schema

NameRequiredDescriptionDefault
credential_nameYesThe candidate credential name.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the trailing "Read-only" adds nothing, but the description does disclose concrete behavior the annotations cannot: the verdict, an RFC1035-normalised form of the name, and the conflicting existing credential. It does not mention permission requirements or whether the check is org-scoped only, which keeps it from a 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?

Two sentences, front-loaded with the action and followed by the return shape. Nothing is redundant except the minor restatement of read-only, which costs a single word.

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?

There is no output schema, and the description compensates by enumerating the three things returned. For a one-parameter, read-only validation tool this covers everything an agent needs 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 100% with a single well-described parameter, so the baseline is 3; the description adds meaning by framing the input as a candidate name and signalling RFC1035 naming rules, which tells the agent the expected format is DNS-style rather than arbitrary text.

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 and resource ("Check whether a credential name is valid and free to use in the organisation") and its scope is unambiguous against siblings like create_secret, delete_credential, or list_credentials — those act on credentials, this only tests a candidate name.

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?

"Free to use in the organisation" clearly frames this as a pre-flight/availability check, which implies it is called before creating a credential. It stops short of naming an explicit alternative or stating when not to bother (e.g., when editing an existing credential and keeping its name).

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.