Skip to main content
Glama
heilgar

Shadcn UI MCP Server

by heilgar

get-block-docs

Retrieve detailed documentation for specific Shadcn UI blocks to facilitate integration and usage in development projects. Supports efficient block management through natural language interactions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
blockYesName of the block to get documentation for

Implementation Reference

  • The main handler function for the 'get-block-docs' tool. It fetches block data using getBlockData helper and returns the JSON-serialized documentation if available.
    export const getBlockDocs = async ({block}: {block: string}) => {
        try {
            const { blockData, error } = await getBlockData(block);
            if (error) return createResponse(error, true);
            if (!blockData) return createResponse("Unexpected error: block data missing", true);
    
            if (!blockData.doc) {
                return createResponse(`No documentation found for block '${block}'`, true);
            }
    
            return createResponse(
                `${JSON.stringify(blockData, null, 2)}`,
                false,
                "application/json"
            );
        } catch (error) {
            return handleError(error, "Error fetching block documentation");
        }
    }
  • src/index.ts:44-53 (registration)
    The tool definition object in toolDefinitions that registers 'get-block-docs' with its description, parameters, schema, and handler reference. This object is used in the server.tool calls.
    "get-block-docs": {
        description: "Get documentation (code) for a specific shadcn/ui block",
        parameters: {
            block: { type: "string", description: "Name of the block to get documentation for" }
        },
        toolSchema: {
            block: z.string().describe("Name of the block to get documentation for")
        },
        handler: getBlockDocs
    },
  • Zod schema for input validation of the 'block' parameter.
    toolSchema: {
        block: z.string().describe("Name of the block to get documentation for")
    },
  • Helper function that retrieves or fetches block data from the resource cache, used exclusively by getBlockDocs.
    async function getBlockData(block: string) {
        if (!block) {
            return { error: "Block name is required" };
        }
        let blockData = resourceCache.get(block);
        if (!blockData) {
            await fetchAndCacheBlocks();
            blockData = resourceCache.get(block);
        }
        if (!blockData) {
            return { error: `Block '${block}' not found. Use list-blocks to see available blocks.` };
        }
        return { blockData };
    }
  • Helper function to fetch and cache block data from shadcn/ui block pages, populating the resourceCache used by getBlockData.
    export async function fetchAndCacheBlocks(): Promise<ComponentDocResource[]> {
        const transformBlocks = (blockPages: Block[][]): ComponentDocResource[] => {
            const allBlocks = blockPages.flat();
            
            return allBlocks.map((block: Block) => ({
                name: block.name,
                description: block.description,
                doc: block.doc,
                commands: [{
                    npm: block.command,
                    pnpm: getCliCommand(block.command, 'pnpm'),
                    yarn: getCliCommand(block.command, 'yarn'),
                    bun: getCliCommand(block.command, 'bun')
                }],
                isBlock: true
            }));
        };
    
        return fetchAndCache(
            'blocks',
            async () => Promise.all(BLOCK_PAGES.map(parseBlocksFromPage)),
            transformBlocks
        );
    }
Behavior1/5

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

Tool has no description.

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

Conciseness1/5

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

Tool has no description.

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?

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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?

Tool has no description.

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/heilgar/shadcn-ui-mcp-server'

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