Skip to main content
Glama
gaudiolab-jp

gaudio-developers-mcp

Official

gaudio_get_key_info

Retrieve API key details including description, creation date, status, permitted models, project name, and remaining credits.

Instructions

Get API key information: description, creation date, status, permitted models, project name, and remaining credits (free + paid).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The tool handler function that registers 'gaudio_get_key_info' with the MCP server. Calls client.getKeyInfo(), wraps the response in MCP text content.
    export function registerGetKeyInfo(server: McpServer, client: GaudioClient) {
      server.tool(
        "gaudio_get_key_info",
        "Get API key information: description, creation date, status, permitted models, project name, and remaining credits (free + paid).",
        {},
        async () => {
          const res = await client.getKeyInfo();
    
          return {
            content: [
              {
                type: "text" as const,
                text: JSON.stringify(res.resultData, null, 2),
              },
            ],
          };
        },
      );
    }
  • Input schema for the tool - empty object (no parameters needed).
    {},
  • src/index.ts:33-33 (registration)
    Registration call: registerGetKeyInfo(server, client) is invoked during server setup.
    registerGetKeyInfo(server, client);
  • src/index.ts:12-12 (registration)
    Import statement for registerGetKeyInfo from the tools/get-key-info module.
    import { registerGetKeyInfo } from "./tools/get-key-info.js";
  • Client helper method getKeyInfo() that sends a GET request to /key/info endpoint on the Gaudiolab REST API.
    async getKeyInfo(): Promise<ApiResponse> {
      return this.request("GET", "/key/info");
    }
Behavior3/5

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

No annotations provided, so the description carries full burden. It states the tool retrieves information, implying a safe, read-only operation, but does not disclose potential side effects (e.g., authentication requirements or rate limits). Given the tool's simplicity, this is minimally adequate but not rich.

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 a single sentence that front-loads the purpose and enumerates key output fields. No wasted words; every element contributes to clarity.

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?

Given no output schema, the description fully covers return values by listing all relevant fields. With zero input parameters and a simple read operation, the description is complete and sufficient for an agent to use the tool 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?

The input schema has zero parameters, so the description need not explain them. It adds value by listing the returned fields, helping the agent understand what the tool provides. Baseline is 4 for no parameters.

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 identifies the tool's action ('Get') and the resource ('API key information'), listing specific attributes (description, creation date, status, etc.). It distinguishes itself from sibling tools like gaudio_create_job and gaudio_separate_audio, which handle different operations.

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

Usage Guidelines3/5

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

The description implies a simple read operation but lacks explicit guidance on when to use this tool versus alternatives. No exclusions or prerequisites are mentioned, though the context of sibling tools suggests it's for retrieving key metadata.

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/gaudiolab-jp/gaudio-developers-mcp'

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