Skip to main content
Glama

get_total_tvl

Retrieve the total value locked (TVL) in SailFish DEX to monitor liquidity and token activity using the EDUCHAIN Agent Kit.

Instructions

Get the total value locked (TVL) in SailFish DEX

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • MCP tool handler for 'get_total_tvl' that invokes subgraph.getTotalTVL() and formats the response as JSON.
    case 'get_total_tvl': {
      const tvl = await subgraph.getTotalTVL();
      
      return {
        content: [
          {
            type: 'text',
            text: JSON.stringify({ totalValueLockedUSD: tvl }, null, 2),
          },
        ],
      };
    }
  • Core implementation that queries the subgraph factory for totalValueLockedUSD.
    export async function getTotalTVL(): Promise<string> {
      try {
        const factory = await getFactory();
        if (!factory) {
          throw new Error('Factory data not available');
        }
        
        return factory.totalValueLockedUSD;
      } catch (error) {
        console.error('Error fetching total TVL:', error);
        throw error;
      }
    }
  • Input schema definition (empty object, no parameters required) and tool registration in the ListTools handler.
    name: 'get_total_tvl',
    description: 'Get the total value locked (TVL) in SailFish DEX',
    inputSchema: {
      type: 'object',
      properties: {},
      required: [],
    },
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. It states the tool retrieves TVL but does not disclose any behavioral traits such as rate limits, authentication needs, data freshness, or error handling. This is a significant gap for a tool with no annotation coverage.

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 directly states the tool's purpose without any unnecessary words. It is appropriately sized and front-loaded, making it easy for an agent to parse quickly.

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

Completeness3/5

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

Given the tool has 0 parameters, no annotations, and no output schema, the description is minimally adequate but lacks depth. It explains what the tool does but does not cover behavioral aspects or output details, which are important for a tool retrieving financial data like TVL.

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 0 parameters with 100% coverage, so no parameter documentation is needed. The description does not add parameter semantics, but this is acceptable given the schema's completeness. A baseline of 4 is appropriate as the tool has no parameters to explain.

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 verb 'Get' and the resource 'total value locked (TVL) in SailFish DEX', making the purpose specific and understandable. However, it does not explicitly differentiate from sibling tools like get_24h_volume or get_top_pools, which might also retrieve DEX metrics, so it misses full sibling distinction.

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?

The description provides no guidance on when to use this tool versus alternatives. It does not mention context, prerequisites, or exclusions, leaving the agent to infer usage based on the name alone, which is insufficient for optimal tool selection.

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

Related 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/SailFish-Finance/educhain-ai-agent-kit'

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