Skip to main content
Glama
ProsodyAI

@prosodyai/mcp-docs

Official
by ProsodyAI

List all docs

list_docs

Browse all available documents in the ProsodyAI documentation server. Filter by section like docs, sdks, recipes, or api to find specific content quickly.

Instructions

List every document in this server. Useful for browsing without a search query.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionNoFilter to a single section.

Implementation Reference

  • src/server.ts:86-115 (registration)
    Registration of the 'list_docs' tool with input schema and handler.
    server.registerTool(
      "list_docs",
      {
        title: "List all docs",
        description:
          "List every document in this server. Useful for browsing without a search query.",
        inputSchema: {
          section: sectionEnum.optional().describe("Filter to a single section."),
        },
      },
      async ({ section }) => {
        const entries = await listEntries(section);
        if (!entries.length) return textResponse("No documents available.");
        const grouped = new Map<string, typeof entries>();
        for (const e of entries) {
          const arr = grouped.get(e.section) ?? [];
          arr.push(e);
          grouped.set(e.section, arr);
        }
        const out: string[] = [];
        for (const [sec, items] of grouped) {
          out.push(`## ${sec}`);
          for (const item of items) {
            out.push(`- ${item.id}  —  ${item.title}`);
          }
          out.push("");
        }
        return textResponse(out.join("\n"));
      },
    );
  • Handler function that calls listEntries(section) and groups/returns results.
    async ({ section }) => {
      const entries = await listEntries(section);
      if (!entries.length) return textResponse("No documents available.");
      const grouped = new Map<string, typeof entries>();
      for (const e of entries) {
        const arr = grouped.get(e.section) ?? [];
        arr.push(e);
        grouped.set(e.section, arr);
      }
      const out: string[] = [];
      for (const [sec, items] of grouped) {
        out.push(`## ${sec}`);
        for (const item of items) {
          out.push(`- ${item.id}  —  ${item.title}`);
        }
        out.push("");
      }
      return textResponse(out.join("\n"));
    },
  • Input schema definition for list_docs: optional section filter.
    inputSchema: {
      section: sectionEnum.optional().describe("Filter to a single section."),
    },
  • Helper function listEntries that returns all content entries, optionally filtered by section.
    export async function listEntries(section?: ContentSection): Promise<ContentEntry[]> {
      const all = await loadContent();
      return section ? all.filter((e) => e.section === section) : all;
    }
  • Type definition for ContentSection used by list_docs input schema.
    export type ContentSection = "docs" | "sdks" | "recipes" | "api";
Behavior3/5

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

No annotations provided, but the description indicates a simple read operation with no side effects mentioned. It lacks details on pagination or rate limits but is straightforward.

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?

Two concise sentences, front-loaded with clear purpose, no wasted words.

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?

Adequate for a simple listing tool with one optional filter; could mention output format but not essential given sibling tools.

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 description coverage is 100%, so the description adds little beyond the schema. It mentions 'every document' but does not elaborate on parameter behavior.

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 action ('List every document in this server') and distinguishes from siblings like search_docs by noting it's for browsing without a query.

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

Usage Guidelines4/5

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

The description provides context ('useful for browsing without a search query') implying use for broad exploration, but does not explicitly name alternatives or when not to use.

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/ProsodyAI/mcp-docs'

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