Skip to main content
Glama
lindoai

mcp-lindoai

Official

Get Client Credits

get_client_credits
Read-only

Retrieve the current credit balance for a specified client by providing their client ID.

Instructions

Get client credit balance.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
client_idYesThe client ID

Implementation Reference

  • The handler function for get_client_credits tool. Makes a GET request to /v1/ai/credits/client?client_id=<id> and returns the credit balance data.
      async ({ client_id }) => {
        const data = await apiCall(`/v1/ai/credits/client?client_id=${client_id}`, "GET");
        const payload = data?.result || data;
        return { content: [{ type: "text", text: JSON.stringify(payload, null, 2) }] };
      }
    );
  • Registration of the get_client_credits tool via server.registerTool with name 'get_client_credits', input schema requiring client_id as a string, and read-only annotation.
    server.registerTool(
      "get_client_credits",
      {
        title: "Get Client Credits",
        description: "Get client credit balance.",
        inputSchema: {
        client_id: z.string().describe("The client ID"),
      },
        annotations: { readOnlyHint: true, destructiveHint: false, openWorldHint: false },
      },
      async ({ client_id }) => {
        const data = await apiCall(`/v1/ai/credits/client?client_id=${client_id}`, "GET");
        const payload = data?.result || data;
        return { content: [{ type: "text", text: JSON.stringify(payload, null, 2) }] };
      }
    );
  • Input schema for get_client_credits requiring a single parameter 'client_id' (string) described as 'The client ID'.
    inputSchema: {
    client_id: z.string().describe("The client ID"),
  • Helper function apiCall used by the handler to make authenticated HTTP requests to the Lindo AI API.
    async function apiCall(path, method, body) {
      const url = `${BASE_URL}${path}`;
      const res = await fetch(url, {
        method,
        headers: {
          Authorization: `Bearer ${API_KEY}`,
          "Content-Type": "application/json",
        },
        ...(body ? { body: JSON.stringify(body) } : {}),
      });
      return res.json();
    }
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 adds no new behavioral context. It could mention that it returns a numeric balance, but it does not contradict annotations.

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

Conciseness4/5

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

The description is a short, clear phrase that communicates the purpose immediately. It earns its place but could be slightly more informative without losing conciseness.

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?

Without an output schema, the description should indicate the return type (e.g., 'returns a numeric balance'). It is minimal and does not fully inform the agent about what to expect.

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?

Input schema coverage is 100% and describes the single parameter 'client_id' simply. The description adds no extra meaning beyond what the schema provides.

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 'Get client credit balance' uses a specific verb 'Get' and resource 'client credit balance', clearly distinguishing it from sibling tools like 'get_credits' (workspace-level) and 'allocate_credits'.

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 on when to use this tool vs. alternatives (e.g., get_credits) or when not to use it. The description lacks context for optimal 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

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

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