Skip to main content
Glama

sodax_get_token_supply

Read-only

Retrieve SODA token supply data including total, circulating, and burned amounts in JSON or markdown format.

Instructions

Get SODA token supply information including total, circulating, and burned amounts

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNoResponse format: 'json' for raw data or 'markdown' for formatted textmarkdown

Implementation Reference

  • Core implementation of getTokenSupply() service function that fetches SODA token supply data from the SODAX API endpoint '/sodax/supply'. Includes caching logic and error handling.
    /**
     * Get SODA token supply info
     */
    export async function getTokenSupply(): Promise<TokenSupply> {
      const cacheKey = "token-supply";
      const cached = getCached<TokenSupply>(cacheKey);
      if (cached) return cached;
    
      try {
        const response = await apiClient.get("/sodax/supply");
        // API returns data directly
        const supply = response.data?.data || response.data;
        setCache(cacheKey, supply);
        return supply;
      } catch (error) {
        console.error("Error fetching token supply:", error);
        throw new Error("Failed to fetch token supply from SODAX API");
      }
    }
  • MCP tool registration for 'sodax_get_token_supply' with server.tool(). Defines input schema (format parameter) and the handler that calls getTokenSupply() and formats the response.
    // Tool 10: Get Token Supply
    server.tool(
      "sodax_get_token_supply",
      "Get SODA token supply information including total, circulating, and burned amounts",
      {
        format: z.nativeEnum(ResponseFormat).optional().default(ResponseFormat.MARKDOWN)
          .describe("Response format: 'json' for raw data or 'markdown' for formatted text")
      },
      READ_ONLY,
      async ({ format }) => {
        try {
          const supply = await getTokenSupply();
          return {
            content: [{
              type: "text",
              text: `## SODA Token Supply\n\n` + formatResponse(supply, format)
            }]
          };
        } catch (error) {
          return {
            content: [{ type: "text", text: `Error: ${error instanceof Error ? error.message : "Unknown error"}` }],
            isError: true
          };
        }
      }
    );
  • Type definition for TokenSupply interface defining the structure of token supply data including totalSupply, circulatingSupply, burnedSupply, lockedSupply, maxSupply, priceUsd, and marketCapUsd.
    /**
     * SODA token supply info
     */
    export interface TokenSupply {
      totalSupply: string;
      circulatingSupply: string;
      burnedSupply?: string;
      lockedSupply?: string;
      maxSupply?: string;
      priceUsd?: number;
      marketCapUsd?: number;
    }
  • Analytics mapping that associates 'sodax_get_token_supply' with the 'api' group for PostHog tracking of tool usage.
    sodax_get_partners: "api",
    sodax_get_token_supply: "api",
  • API documentation listing showing 'sodax_get_token_supply' as one of the available tools in the /api endpoint response.
    "sodax_get_token_supply",
Behavior4/5

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

Annotations already indicate read-only, non-destructive, and open-world behavior, which the description does not contradict. The description adds value by specifying the types of supply information returned (total, circulating, burned), providing context beyond annotations. However, it lacks details on rate limits, authentication needs, or error handling.

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, efficient sentence that front-loads the core purpose ('Get SODA token supply information') and elaborates with specific details ('including total, circulating, and burned amounts'). There is no wasted wording, making it highly concise and well-structured.

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 low complexity (one optional parameter), rich annotations (read-only, non-destructive, open-world), and no output schema, the description is mostly complete. It clearly states what data is returned, though it could benefit from mentioning response format implications or example outputs to fully compensate for the lack of output schema.

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?

The input schema has 100% description coverage, fully documenting the 'format' parameter with enum values and default. The description does not add any parameter-specific information beyond the schema, so it meets the baseline of 3 for high schema coverage without extra semantic value.

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 verb 'Get' and the specific resource 'SODA token supply information', including detailed breakdowns ('total, circulating, and burned amounts'). It effectively distinguishes this tool from siblings like 'sodax_get_volume' or 'sodax_get_transaction' by focusing on token supply metrics rather than other blockchain data.

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 usage for retrieving token supply data, but it does not explicitly state when to use this tool versus alternatives (e.g., other 'sodax_get_' tools). There is no guidance on prerequisites, exclusions, or specific contexts, leaving the agent to infer usage based on the purpose alone.

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/gosodax/sodax-builders-mcp'

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