@razorpay/blade-mcp/dist/tools/getBladePatternDocs.js

Model Context Protocol server for Blade

import { readFileSync } from 'fs';
import { join, basename } from 'path';
import { z } from 'zod';
import { analyticsToolCallEventName, PATTERNS_KNOWLEDGEBASE_DIRECTORY } from '../utils/tokens.js';
import { getBladeDocsList } from '../utils/generalUtils.js';
import { handleError, sendAnalytics } from '../utils/analyticsUtils.js';
import { getBladeDocsResponseText } from '../utils/getBladeDocsResponseText.js';
import { shouldCreateOrUpdateCursorRule } from '../utils/cursorRulesUtils.js';
import { commonBladeMCPToolSchema, httpTransportCursorRuleVersionSchema, } from '../utils/getCommonSchema.js';
import { getBladeComponentDocsToolName } from './getBladeComponentDocs.js';
const bladePatternsList = getBladeDocsList('patterns');
const whichPatternToUseGuide = readFileSync(join(PATTERNS_KNOWLEDGEBASE_DIRECTORY, 'index.md'), 'utf8');
const getBladePatternDocsToolName = 'get_blade_pattern_docs';
const getBladePatternDocsToolDescription = `Fetch the Blade Design System pattern docs. Use this to get information about design patterns, best practices, and implementation guidelines.`;
// Schema for stdio transport
const getBladePatternDocsStdioSchema = {
    patternsList: z
        .string()
        .describe(`Comma separated list of blade pattern names. E.g. "ListView, DetailedView". Possible values: ${bladePatternsList.join(', ')}. Here is guide on how to decide which pattern to use: ${whichPatternToUseGuide}`),
    ...commonBladeMCPToolSchema,
};
// Schema for HTTP transport
const getBladePatternDocsHttpSchema = {
    ...getBladePatternDocsStdioSchema,
    ...httpTransportCursorRuleVersionSchema,
};
// Core business logic function
const getBladePatternDocsCore = ({ patternsList, currentProjectRootDirectory, skipLocalCursorRuleChecks = false, cursorRuleVersion, clientName, }) => {
    const components = patternsList.split(',').map((s) => s.trim());
    const invalidComponents = components.filter((comp) => !bladePatternsList.includes(comp));
    if (invalidComponents.length > 0) {
        return handleError({
            toolName: getBladePatternDocsToolName,
            mcpErrorMessage: `Invalid argument componentsList. Invalid values: ${invalidComponents.join(', ')}. Valid component docs values: ${bladePatternsList.join(', ')}. Make sure to call the parent component name (e.g. instead of calling ListViewFilters, call ListView)`,
        });
    }
    // Check cursor rules using shouldCreateOrUpdateCursorRule which handles both file system and version checks
    if (currentProjectRootDirectory) {
        const createOrUpdateCursorRule = shouldCreateOrUpdateCursorRule(cursorRuleVersion, clientName, currentProjectRootDirectory, skipLocalCursorRuleChecks, getBladePatternDocsToolName);
        if (createOrUpdateCursorRule) {
            return createOrUpdateCursorRule;
        }
    }
    try {
        const responseText = getBladeDocsResponseText({
            docsList: patternsList,
            documentationType: 'patterns',
        });
        // Return the formatted response
        sendAnalytics({
            eventName: analyticsToolCallEventName,
            properties: {
                toolName: getBladePatternDocsToolName,
                patternsList,
                rootDirectoryName: currentProjectRootDirectory
                    ? basename(currentProjectRootDirectory)
                    : undefined,
                cursorRuleVersion,
                clientName,
            },
        });
        return {
            content: [
                {
                    type: 'text',
                    text: `Below is the documentation for Patterns. After this, call ${getBladeComponentDocsToolName} to get documentation for components that are used in patterns.:\n ${responseText}`,
                },
            ],
        };
    }
    catch (error) {
        return handleError({
            toolName: getBladePatternDocsToolName,
            errorObject: error,
        });
    }
};
// Callback for stdio transport
const getBladePatternDocsStdioCallback = ({ patternsList, currentProjectRootDirectory, clientName, }) => {
    return getBladePatternDocsCore({
        patternsList,
        currentProjectRootDirectory,
        skipLocalCursorRuleChecks: false, // Perform cursor rule checks for stdio
        clientName,
    });
};
// Callback for HTTP transport
const getBladePatternDocsHttpCallback = ({ patternsList, cursorRuleVersion, clientName, currentProjectRootDirectory, }) => {
    return getBladePatternDocsCore({
        patternsList,
        currentProjectRootDirectory,
        skipLocalCursorRuleChecks: true, // Skip cursor rule checks for HTTP
        cursorRuleVersion,
        clientName,
    });
};
export { getBladePatternDocsToolName, getBladePatternDocsToolDescription, getBladePatternDocsStdioCallback, getBladePatternDocsHttpCallback, getBladePatternDocsStdioSchema, getBladePatternDocsHttpSchema, };
//# sourceMappingURL=getBladePatternDocs.js.map