Skip to main content
Glama

sodax_get_total_supply

Read-only

Get SODA token total supply as a plain number, with output in JSON or markdown.

Instructions

Get SODA token total supply as a plain number

Input Schema

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

Implementation Reference

  • MCP tool handler for 'sodax_get_total_supply'. Registers the tool with a 'format' parameter, calls getTotalSupply() from the service layer, and formats the response as markdown (default) or JSON.
    server.tool(
      "sodax_get_total_supply",
      "Get SODA token total supply as a plain number",
      {
        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 getTotalSupply();
          return {
            content: [{
              type: "text",
              text: `## SODA Total Supply\n\n` + formatResponse(supply, format)
            }]
          };
        } catch (error) {
          return {
            content: [{ type: "text", text: `Error: ${error instanceof Error ? error.message : "Unknown error"}` }],
            isError: true
          };
        }
      }
    );
  • Service-layer helper function that calls the SODAX API endpoint GET /sodax/total_supply and returns the response data.
    export async function getTotalSupply(): Promise<unknown> {
      try {
        const response = await apiClient.get("/sodax/total_supply");
        return response.data;
      } catch (error) {
        console.error("Error fetching total supply:", error);
        throw new Error("Failed to fetch total supply from SODAX API");
      }
    }
  • src/index.ts:257-264 (registration)
    Registration of the tool in the 'partnersAndToken' group within the main tool registry/config.
    partnersAndToken: [
      "sodax_get_partners",
      "sodax_get_partner_summary",
      "sodax_get_token_supply",
      "sodax_get_total_supply",
      "sodax_get_circulating_supply",
      "sodax_refresh_cache"
    ],
  • Maps the tool name to the 'api' group in the analytics tool group resolver.
    sodax_get_total_supply: "api",
    sodax_get_circulating_supply: "api",
    sodax_refresh_cache: "api",
  • Drift check mapping: links the API endpoint GET /sodax/total_supply to the tool name for monitoring API contract changes.
    "GET /sodax/total_supply": {
      tool: "sodax_get_total_supply",
      params: [],
      requiredParams: [],
    },
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description's additional context 'as a plain number' provides minor value. No contradictory or misleading statements.

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?

Extremely concise single sentence that is front-loaded with the core action. No unnecessary words, every part is informative.

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 simple tool (one optional parameter, no output schema, annotations present), the description sufficiently covers what the tool does and the response format. Could mention edge cases or default behavior, but not essential.

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?

Schema coverage is 100% with a single parameter 'format' already described in the schema. The description does not add further meaning to the parameter beyond 'plain number', which is not a parameter detail.

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 tool retrieves the total supply of the SODA token as a plain number, with a specific verb 'Get' and resource 'total supply'. This distinguishes it from sibling tools like sodax_get_circulating_supply or sodax_get_token_supply.

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?

No explicit guidance on when to use this tool versus alternatives like sodax_get_circulating_supply or sodax_get_token_supply. The description implies its use for total supply, but lacks exclusions or context for 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/gosodax/builders-sodax-mcp-server'

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