Skip to main content
Glama
ricleedo

MCP Server Boilerplate

by ricleedo

get-mcp-docs

Generate documentation for MCP servers by providing a server name. This tool helps developers create structured documentation from the MCP Server Boilerplate template.

Instructions

Make an MCP server

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesThe name of the MCP server

Implementation Reference

  • The handler function for the 'get-mcp-docs' tool. It generates a markdown-formatted TypeScript code snippet for a basic MCP server implementation and returns it as text content.
      async ({ name }) => {
        const response = `
    # Main file for the MCP server
    
    \`\`\`ts
    import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
    import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
    import { z } from "zod";
    // Create the MCP server
    const server = new McpServer({
      name: "hello-world",
      version: "1.0.0",
    });
    
    // Tool: Store conversation with embeddings
    server.tool(
      "hello-world",
      "Say hello to the user",
      {
        name: z.string().describe("The name of the user"),
      },
      async ({ name }) => {
        const response = \`Hello ${name}\`;
    
        return {
          content: [
            {
              type: "text",
              text: response,
            },
          ],
        };
      }
    );
    
    // Start the server
    async function main() {
      try {
        const transport = new StdioServerTransport();
        await server.connect(transport);
        console.error("MCP Hello World Server running...");
      } catch (error) {
        console.error("Error starting server:", error);
        process.exit(1);
      }
    }
    
    main().catch(console.error);
    \`\`\`
    `;
        return {
          content: [
            {
              type: "text",
              text: response,
            },
          ],
        };
      }
  • Input schema for the 'get-mcp-docs' tool, defining a single 'name' parameter as a string using Zod.
    {
      name: z.string().describe("The name of the MCP server"),
    },
  • src/index.ts:33-98 (registration)
    Registration of the 'get-mcp-docs' tool using the McpServer.tool() method, specifying name, description, input schema, and handler function.
    server.tool(
      "get-mcp-docs",
      "Make an MCP server",
      {
        name: z.string().describe("The name of the MCP server"),
      },
      async ({ name }) => {
        const response = `
    # Main file for the MCP server
    
    \`\`\`ts
    import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
    import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
    import { z } from "zod";
    // Create the MCP server
    const server = new McpServer({
      name: "hello-world",
      version: "1.0.0",
    });
    
    // Tool: Store conversation with embeddings
    server.tool(
      "hello-world",
      "Say hello to the user",
      {
        name: z.string().describe("The name of the user"),
      },
      async ({ name }) => {
        const response = \`Hello ${name}\`;
    
        return {
          content: [
            {
              type: "text",
              text: response,
            },
          ],
        };
      }
    );
    
    // Start the server
    async function main() {
      try {
        const transport = new StdioServerTransport();
        await server.connect(transport);
        console.error("MCP Hello World Server running...");
      } catch (error) {
        console.error("Error starting server:", error);
        process.exit(1);
      }
    }
    
    main().catch(console.error);
    \`\`\`
    `;
        return {
          content: [
            {
              type: "text",
              text: response,
            },
          ],
        };
      }
    );
Behavior1/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure but fails completely. 'Make an MCP server' doesn't indicate whether this is a read or write operation, what permissions might be required, whether it has side effects, what happens when invoked, or what kind of output to expect. The description provides zero behavioral context beyond the ambiguous verb 'Make'.

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

Conciseness2/5

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

While the description is extremely concise (just three words), this represents under-specification rather than effective brevity. The single phrase 'Make an MCP server' doesn't provide enough information to be useful, making it inefficient rather than appropriately concise. Every word should earn its place, but here the words don't provide sufficient value.

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

Completeness1/5

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

Given that this is a tool with one parameter but no annotations and no output schema, the description is completely inadequate. For a tool that presumably performs some action (implied by 'Make'), the description should explain what happens when invoked, what the result looks like, and any important behavioral characteristics. The current description leaves the agent guessing about the tool's purpose and behavior.

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?

The input schema has 100% description coverage with the 'name' parameter clearly documented as 'The name of the MCP server'. The description adds no additional parameter information beyond what the schema provides. According to the scoring rules, when schema_description_coverage is high (>80%), the baseline is 3 even with no param info in the description, which applies here.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Make an MCP server' is a tautology that essentially restates the tool name 'get-mcp-docs' without clarifying what 'make' means in this context. It doesn't specify what resource is being created or what the tool actually does - whether it generates documentation, creates a server instance, or something else. The description fails to distinguish this tool from its sibling 'hello-world' or explain what specific action is performed.

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

Usage Guidelines1/5

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

The description provides absolutely no guidance on when to use this tool versus alternatives. There's no mention of prerequisites, appropriate contexts, or when this tool should be selected over the sibling 'hello-world' tool. The agent receives no usage instructions beyond the vague description text.

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/ricleedo/reddit-mcp'

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