Skip to main content
Glama

Set endpoint auth

set_endpoint_auth

Point an agent's attached API endpoint at authentication BY REFERENCE (never inline secrets). Either reuse an existing AuthProfile (auth_profile_id), define one inline (auth_method+auth_config), or clear the per-agent override (use_endpoint_auth=false).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
agent_idYesTarget agent's id (from list_agents / create_agent / get_catalog view=agents).
auth_configNoNon-secret auth configuration for an inline profile (reference secrets, never raw credentials).
auth_methodNoAuth type when defining a profile inline.
endpoint_idYesId of the attached API endpoint.
auth_profile_idNoId of an existing org AuthProfile to attach (empty string clears it).
auth_profile_nameNoOptional name for an inline-created auth profile.
use_endpoint_authNofalse clears the per-agent auth override (falls back to the endpoint's own auth).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • changedInput schema / additionalProperties
      Previous value: -trueNew value: +false
    • addedInput schema / properties / agent_id / description
      Added value: +"Target agent's id (from list_agents / create_agent / get_catalog view=agents)."
    • addedInput schema / properties / auth_config
      Added value: +{
      +  "description": "Non-secret auth configuration for an inline profile (reference secrets, never raw credentials).",
      +  "type": "object"
      +}
    • addedInput schema / properties / auth_method
      Added value: +{
      +  "description": "Auth type when defining a profile inline.",
      +  "enum": [
      +    "none",
      +    "api_key",
      +    "bearer",
      +    "basic",
      +    "oauth2",
      +    "jwt",
      +    "custom"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / auth_profile_id
      Added value: +{
      +  "description": "Id of an existing org AuthProfile to attach (empty string clears it).",
      +  "type": "string"
      +}
    • addedInput schema / properties / auth_profile_name
      Added value: +{
      +  "description": "Optional name for an inline-created auth profile.",
      +  "type": "string"
      +}
    • addedInput schema / properties / endpoint_id / description
      Added value: +"Id of the attached API endpoint."
    • addedInput schema / properties / use_endpoint_auth
      Added value: +{
      +  "description": "false clears the per-agent auth override (falls back to the endpoint's own auth).",
      +  "type": "boolean"
      +}
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations signal readOnlyHint=false and destructiveHint=false, so the mutation profile is already known. The description adds the security-critical behavior 'BY REFERENCE (never inline secrets)' and the fallback behavior when use_endpoint_auth=false; it could still disclose overwrite/conflict behavior, but the added context is meaningful.

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-load the core security rule and then compactly list the three invocation modes. Every clause maps to parameters or behavior; no filler.

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 tool with 7 parameters, a nested object, and no output schema, the description covers the principal modes and the secret-handling constraint, and the schema fills in parameter detail. It does not state what happens when none of the mode parameters are supplied or what the response is, but these are acceptable gaps given the strong schema and mode enumeration.

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?

With 100% schema coverage, the schema already explains each field. The description adds cross-parameter semantics by defining the three mutually relevant modes: auth_profile_id reuse, auth_method+auth_config inline definition, and use_endpoint_auth=false clearing. This is more than the schema's per-field documentation.

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

Purpose4/5

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

The description identifies a clear verb+resource: 'Point an agent's attached API endpoint at authentication' and enumerates three outcome modes (reuse, inline, clear). It is unambiguous about what the tool does, though it does not explicitly contrast it with siblings like update_api_endpoint or attach_api_endpoint, so it stops short of full sibling differentiation.

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?

It offers explicit in-tool usage direction: reuse an AuthProfile, define one inline, or clear the override, and ties each mode to specific parameters. There is no explicit when-not-to-use or sibling alternative, so it doesn't earn a 5.

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