Skip to main content
Glama

set_api_key

Set your FaceSign API key for this session. This must be called before any other FaceSign tools. Get your API key from the FaceSign dashboard. The key starts with sk_live_... or sk_test_... Optionally override the API server URL via serverUrl — intended for FaceSign developers pointing the SDK at a non-production backend (e.g. a dev server). Leave unset to use the default production API.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
apiKeyYesYour FaceSign API key (sk_live_... or sk_test_...)
serverUrlNoOptional FaceSign API server URL override. Only set this if the user explicitly asks to target a non-default server (e.g. a dev backend). Omit otherwise to use the production API.

TDQS

A4.5/5.0
Behavior4/5

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

No annotations are provided, so the description carries the full burden. It discloses session-scoped behavior, key format, and the optional serverUrl override with production default. It doesn't mention error handling or side effects but adequately explains the tool's function for a simple setter.

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 concise sentences, front-loaded with purpose and prerequisite, each sentence adds value. No redundancy or fluff.

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 2-param setter with full schema coverage, the description provides all necessary context: purpose, prerequisite, optional use case, and default behavior. No gaps.

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 covers both parameters with detailed descriptions (100% coverage). The description adds the session requirement but doesn't add significant parameter-level meaning beyond what the schema already provides. Baseline 3 is appropriate.

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 clearly states the tool's function: 'Set your FaceSign API key for this session' with a specific verb and resource. It also distinguishes itself from sibling tools by noting it must be called before any other FaceSign tools, establishing it as a setup prerequisite.

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

Usage Guidelines5/5

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

Explicitly states when to call this tool ('must be called before any other FaceSign tools') and provides guidance on when to set serverUrl (only if explicitly targeting a non-default server). This clearly differentiates usage from alternatives and gives actionable instructions.

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.9/5.0
Disambiguation5/5

Each tool targets a distinct action: setting the API key, launching the UI, retrieving session details, listing sessions, and exporting as an app. Even though launch_session_ui and export_app both require HTML/UI string parameters, their purposes (local run vs. deployable export) are clearly different.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case: set_api_key, launch_session_ui, get_session, list_sessions, export_app. The verbs are clear and the nouns are the corresponding resource, making the pattern predictable.

Tool Count5/5

With 5 tools, the set is well-scoped and each tool directly supports the server's purpose of managing FaceSign sessions. This is comfortably within the ideal 3-15 range and avoids unnecessary bloat.

Completeness4/5

The tool surface covers the core workflow: setting the API key, launching a session UI, retrieving session data, listing sessions, and exporting a standalone app. A minor gap is the lack of explicit session cancellation or deletion, but this appears manageable since sessions are ephemeral per launch and status can be filtered.

Resources