Skip to main content
Glama

docs_list_tools

Read-only

Discover available SDK documentation tools and their parameters to access up-to-date API data and build with live information.

Instructions

List all SDK documentation tools with parameters. Essential for discovering what's available.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Complete implementation of docs_list_tools handler - fetches GitBook tools and formats them with full parameter details
    server.tool(
      "docs_list_tools",
      "List all SDK documentation tools with parameters. Essential for discovering what's available.",
      {},
      DOCS_READ_ONLY,
      async () => {
        const tools = await fetchGitBookTools();
        if (tools.length === 0) {
          return {
            content: [{
              type: "text",
              text: `⚠️ No SDK documentation tools available.\n\n**Troubleshooting:**\n1. Run \`docs_refresh\` to reconnect\n2. Check \`docs_health\` for status\n3. The GitBook MCP at docs.sodax.com may be temporarily down\n\n**Alternative:** SODAX API tools (sodax_*) work independently.`
            }]
          };
        }
        
        const toolList = tools.map(t => {
          const params = t.inputSchema.properties 
            ? Object.entries(t.inputSchema.properties).map(([k, v]) => {
                const prop = v as { type?: string; description?: string };
                const required = t.inputSchema.required?.includes(k) ? " (required)" : "";
                return `  - \`${k}\`: ${prop.type || "any"}${required}${prop.description ? ` — ${prop.description}` : ""}`;
              }).join("\n")
            : "  (no parameters)";
          return `### \`docs_${t.name}\`\n${t.description}\n\n**Parameters:**\n${params}`;
        }).join("\n\n---\n\n");
        
        return {
          content: [{
            type: "text",
            text: `# SDK Documentation Tools\n\n${tools.length} tools from docs.sodax.com:\n\n---\n\n${toolList}`
          }]
        };
      }
    );
  • Input schema for docs_list_tools - empty object indicates no parameters required
    {},
  • Registration of docs_list_tools tool via server.tool() with name, description, schema, and handler
    server.tool(
      "docs_list_tools",
      "List all SDK documentation tools with parameters. Essential for discovering what's available.",
      {},
      DOCS_READ_ONLY,
      async () => {
        const tools = await fetchGitBookTools();
        if (tools.length === 0) {
          return {
            content: [{
              type: "text",
              text: `⚠️ No SDK documentation tools available.\n\n**Troubleshooting:**\n1. Run \`docs_refresh\` to reconnect\n2. Check \`docs_health\` for status\n3. The GitBook MCP at docs.sodax.com may be temporarily down\n\n**Alternative:** SODAX API tools (sodax_*) work independently.`
            }]
          };
        }
        
        const toolList = tools.map(t => {
          const params = t.inputSchema.properties 
            ? Object.entries(t.inputSchema.properties).map(([k, v]) => {
                const prop = v as { type?: string; description?: string };
                const required = t.inputSchema.required?.includes(k) ? " (required)" : "";
                return `  - \`${k}\`: ${prop.type || "any"}${required}${prop.description ? ` — ${prop.description}` : ""}`;
              }).join("\n")
            : "  (no parameters)";
          return `### \`docs_${t.name}\`\n${t.description}\n\n**Parameters:**\n${params}`;
        }).join("\n\n---\n\n");
        
        return {
          content: [{
            type: "text",
            text: `# SDK Documentation Tools\n\n${tools.length} tools from docs.sodax.com:\n\n---\n\n${toolList}`
          }]
        };
      }
    );
  • Helper function that returns list of available GitBook tool names including docs_list_tools
    export async function getGitBookToolNames(): Promise<string[]> {
      try {
        const tools = await fetchGitBookTools();
        const proxyTools = tools.map(t => `docs_${t.name}`);
        return [...proxyTools, "docs_health", "docs_refresh", "docs_list_tools"];
      } catch {
        return ["docs_health", "docs_refresh", "docs_list_tools"];
      }
    }
  • Analytics mapping for docs_list_tools to the 'sdk-docs' tracking group
    docs_list_tools: "sdk-docs",
Behavior3/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true, and destructiveHint=false, so the agent knows this is a safe, read-only operation that may return incomplete results. The description adds context about being 'Essential for discovering what's available', which hints at its exploratory nature, but doesn't provide additional behavioral details like response format or limitations.

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 clearly states the tool's purpose and usage context. Every word earns its place with no redundancy or unnecessary elaboration.

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?

For a zero-parameter tool with comprehensive annotations (readOnlyHint, openWorldHint, destructiveHint), the description provides adequate context about its purpose. However, without an output schema, it doesn't describe what the tool returns (e.g., list format, structure of tool information), leaving a gap in understanding the response.

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?

With 0 parameters and 100% schema description coverage, the schema fully documents the lack of inputs. The description doesn't need to add parameter information, so it appropriately focuses on the tool's purpose without redundant details.

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 'List' and resource 'all SDK documentation tools with parameters', providing a specific purpose. However, it doesn't explicitly differentiate from sibling tools like 'docs_searchDocumentation' which might also list tools but with search capabilities.

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 context with 'Essential for discovering what's available', suggesting this tool should be used for initial exploration. However, it doesn't provide explicit guidance on when to use this versus alternatives like 'docs_searchDocumentation' or mention any prerequisites.

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