Skip to main content
Glama

skvil_register

Register for a free API key to verify AI agent security certifications using blockchain-based trust records. The key caches locally for automatic use with security scanning tools.

Instructions

Register for a free Skvil API key. The key is automatically cached locally for future use. No sign-up or account required. Other tools (skvil_scan, skvil_report) will use the cached key automatically.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • src/tools.ts:245-290 (registration)
    Tool registration for skvil_register. Registers the tool with the MCP server, including description and handler function that checks for existing API keys and calls api.register().
    // ── skvil_register ────────────────────────────────────────────────────────
    server.tool(
      'skvil_register',
      'Register for a free Skvil API key. The key is automatically cached ' +
        'locally for future use. No sign-up or account required. Other tools ' +
        '(skvil_scan, skvil_report) will use the cached key automatically.',
      {},
      async () => {
        try {
          const existing = getApiKey();
          if (existing) {
            return {
              content: [
                {
                  type: 'text',
                  text:
                    'An API key is already configured.\n\n' +
                    'To register a new key, unset the `SKVIL_API_KEY` env var and ' +
                    'delete `~/.skvil/mcp-config.json`, then try again.',
                },
              ],
            };
          }
    
          const result = await api.register();
          return {
            content: [
              {
                type: 'text',
                text:
                  '**API key registered successfully!**\n\n' +
                  `- **Key prefix:** ${result.key_prefix}...\n` +
                  `- **Tier:** ${result.tier}\n\n` +
                  'The key has been cached in `~/.skvil/mcp-config.json`.\n' +
                  'You can now use `skvil_scan` and `skvil_report`.',
              },
            ],
          };
        } catch (error) {
          return {
            content: [{ type: 'text', text: formatError('register', error) }],
            isError: true,
          };
        }
      },
    );
  • Core API handler that makes a POST request to /register endpoint, saves the API key locally, and returns the registration result with key prefix and tier.
    /** Register for a free API key and cache it locally. */
    export async function register(): Promise<RegisterResponse> {
      const result = await request<RegisterResponse>('POST', '/register');
      saveApiKey(result.api_key, result.key_prefix);
      return result;
    }
  • Type definition for the RegisterResponse schema that defines the structure of the API registration response including api_key, key_prefix, and tier fields.
    export interface RegisterResponse {
      api_key: string;
      key_prefix: string;
      tier: string;
    }
  • Helper function that saves the newly registered API key to ~/.skvil/mcp-config.json along with key prefix and registration timestamp. Updates the in-memory cache.
    /** Cache a newly registered API key for future use. */
    export function saveApiKey(apiKey: string, keyPrefix: string): void {
      const config = readConfig();
      config.api_key = apiKey;
      config.key_prefix = keyPrefix;
      config.registered_at = new Date().toISOString();
      writeConfig(config);
      cachedApiKey = apiKey;
    }
Behavior4/5

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

With no annotations provided, the description carries full burden and does well by disclosing key behavioral traits: it's a registration tool with no sign-up/account required, the key is automatically cached locally, and other tools will use it automatically. It doesn't mention rate limits or error handling, but covers core functionality adequately.

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?

The description is front-loaded with the main purpose, followed by important behavioral details in three concise sentences with zero wasted words, making it easy to scan and understand quickly.

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 the tool's simplicity (0 parameters, no annotations, no output schema), the description is nearly complete: it explains what it does, how it behaves, and its relationship to siblings. It could mention what happens on failure or the key format, but for this context, it's sufficient.

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 0 parameters and 100% schema coverage, the baseline is 4. The description adds value by explaining that no input is needed ('No sign-up or account required'), which clarifies the parameterless nature beyond what the empty schema indicates.

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 specific action ('Register for a free Skvil API key') and resource ('Skvil API key'), distinguishing it from siblings like skvil_scan or skvil_report by focusing on key acquisition rather than scanning or reporting functions.

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?

It explicitly states when to use this tool ('Register for a free Skvil API key') and provides clear alternatives/context by mentioning that other tools (skvil_scan, skvil_report) will use the cached key automatically, indicating this should be run first for key setup.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Skvil-IA/skvil-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server