Skip to main content
Glama

get_api_key_information

Retrieve API key details for Bybit exchange to manage trading account access and permissions.

Instructions

Get API key information

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The core handler function that executes the tool logic by calling the Bybit API endpoint '/v5/user/query-api' to retrieve API key information.
    async getApiKeyInformation(): Promise<BybitResponse<ApiKeyInfo> | { error: string }> {
      return this.makeBybitRequest('/v5/user/query-api', 'GET', {});
  • src/index.ts:449-456 (registration)
    Tool registration in the MCP server's tool list, defining the name, description, and empty input schema.
    {
      name: 'get_api_key_information',
      description: 'Get API key information',
      inputSchema: {
        type: 'object',
        properties: {},
      },
    },
  • Dispatch handler in the CallToolRequestSchema that invokes the BybitService method and formats the response.
    case 'get_api_key_information': {
      const result = await this.bybitService.getApiKeyInformation();
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify(result, null, 2),
          },
        ],
      };
    }
  • TypeScript interface defining the structure of the API key information response from Bybit.
    export interface ApiKeyInfo {
      id: string;
      note: string;
      apiKey: string;
      readOnly: number;
      secret: string;
      permissions: {
        ContractTrade: string[];
        Spot: string[];
        Wallet: string[];
        Options: string[];
        Derivatives: string[];
        CopyTrading: string[];
        BlockTrade: string[];
        Exchange: string[];
        NFT: string[];
        Affiliate: string[];
      };
      ips: string[];
      type: number;
      deadlineDay: number;
      expiredAt: string;
      createdAt: string;
      unified: number;
      uta: number;
      userID: number;
      inviterID: number;
      vipLevel: string;
      mktMakerLevel: string;
      affiliateID: number;
      rsaPublicKey: string;
      isMaster: boolean;
      parentUid: string;
      kycLevel: string;
      kycRegion: string;
Behavior2/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 of behavioral disclosure. 'Get API key information' implies a read-only operation, but it doesn't specify whether this requires authentication, what format the information returns (e.g., JSON details vs. simple status), or any rate limits or side effects. For a tool that likely handles sensitive credentials, this lack of transparency is a significant gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise ('Get API key information')—just three words. While this avoids waste, it's arguably under-specified rather than efficiently informative. It lacks the front-loaded detail needed for clarity, such as specifying what 'information' entails. The structure is minimal but fails to earn its place by adding sufficient value.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity of API key management in a trading context, the description is incomplete. No annotations exist to cover behavioral aspects, and there's no output schema to explain return values. The description doesn't address what information is retrieved, how it's formatted, or security implications. For a tool that could involve sensitive data, this leaves critical gaps for an agent.

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 tool has 0 parameters, and the input schema has 100% description coverage (though empty). The description doesn't need to compensate for any parameter documentation gaps. A baseline of 4 is appropriate since there are no parameters to explain, though a perfect 5 would require the description to explicitly note the lack of parameters, which it doesn't do.

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

Purpose2/5

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

The description 'Get API key information' is a tautology that essentially restates the tool name without adding meaningful specificity. It doesn't explain what kind of information is retrieved (e.g., permissions, creation date, usage limits) or distinguish this tool from sibling tools like 'get_access_key' or 'get_secret_key'. While it uses a clear verb ('Get'), it lacks the resource specificity needed for a higher score.

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

Usage Guidelines1/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., authentication requirements), appropriate contexts (e.g., checking key status before trading), or exclusions (e.g., not for creating or modifying keys). With sibling tools like 'get_access_key' and 'get_secret_key' present, this omission is particularly problematic for agent decision-making.

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/kondisettyravi/mcp-bybit-node'

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