Skip to main content
Glama

Set Civify API Key

civify_set_api_key
Idempotent

Set or switch the active Civify API key for this agent session. Validates the key with the server immediately.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
api_keyYesCivify API key (starts with 'cv-fy-').

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
userNoAuthenticated user profile details
statusYesAuthentication status (AUTHENTICATED)
messageYesConfirmation message

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 provide idempotentHint=true and destructiveHint=false. The description adds the useful behavioral detail that the key is 'validated with the server immediately', implying a network call and possible error on invalid keys. No contradiction with annotations.

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 short sentences with the primary action front-loaded and a relevant side effect immediately after. No filler or redundancy.

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 single-parameter, idempotent, non-destructive setter with an output schema, the description covers the action, session scope, and validation behavior. Nothing needed for correct invocation is missing.

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 100% and the single api_key parameter is fully documented with type and format hint. The description adds no further parameter detail, so baseline 3 applies.

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 uses specific verbs 'Set or switch' and names the resource 'active Civify API key', scoped to 'this agent session'. This clearly distinguishes it from sibling tools like civify_login or civify_logout.

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 phrase 'for this agent session' gives clear context for when this tool is appropriate. It doesn't explicitly mention alternatives or exclusions, but the intended usage scenario is evident.

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