Skip to main content
Glama

sodax_get_token_supply

Read-only

Fetch SODA token supply details including total, circulating, and burned amounts. Output in JSON or markdown.

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

  • Handler function that fetches SODA token supply from the SODAX API via GET /sodax/supply, with caching support.
    /**
     * 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");
      }
    }
  • Tool registration using server.tool() with name 'sodax_get_token_supply', description, schema (format param), and handler that calls getTokenSupply().
    // 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
          };
        }
      }
    );
  • TypeScript interface defining the TokenSupply schema returned by the handler.
    /**
     * SODA token supply info
     */
    export interface TokenSupply {
      totalSupply: string;
      circulatingSupply: string;
      burnedSupply?: string;
      lockedSupply?: string;
      maxSupply?: string;
      priceUsd?: number;
      marketCapUsd?: number;
    }
  • Analytics category assignment mapping sodax_get_token_supply to 'api' category for usage tracking.
    sodax_get_token_supply: "api",
    sodax_get_total_supply: "api",
    sodax_get_circulating_supply: "api",
    sodax_refresh_cache: "api",
  • API drift check mapping for the GET /sodax/supply endpoint to the tool name for validation purposes.
    "GET /sodax/supply": {
      tool: "sodax_get_token_supply",
      params: [],
      requiredParams: [],
      responseFields: [],
    },
Behavior3/5

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

Annotations already declare the tool as read-only and non-destructive. The description adds that it returns total, circulating, and burned amounts, which is useful but does not reveal additional behavioral traits like data freshness, pagination, or any side effects. It meets the baseline for a simple read operation.

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 concisely communicates the tool's purpose and outputs without any fluff or redundancy.

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 low complexity, one optional parameter, and annotations covering safety, the description adequately explains the return values. It could be more specific about the return format (e.g., whether amounts are combined or separate), but for a supply tool it is sufficiently complete.

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 single parameter 'format' has full schema coverage with a description in the input schema. The tool description does not add any additional semantics beyond what the schema provides, so a baseline score of 3 is appropriate.

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

Purpose4/5

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

The description clearly states the tool retrieves SODA token supply information including total, circulating, and burned amounts. The verb 'Get' and resource are specific, but it does not explicitly differentiate from sibling tools like 'sodax_get_circulating_supply' or 'sodax_get_total_supply', which are more targeted.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus the more specific siblings (e.g., sodax_get_circulating_supply, sodax_get_total_supply). Users must infer from the description that this tool is for comprehensive supply data. There are no explicit when-to-use or when-not-to-use instructions.

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

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