@the_cfdude/productboard-mcp/build/documentation/tool-documentation.d.ts

Model Context Protocol server for Productboard REST API with dynamic tool loading

/**
 * Comprehensive tool documentation with examples and best practices
 */
export interface ToolDocumentation {
    description: string;
    detailedDescription?: string;
    examples: ToolExample[];
    commonErrors?: CommonError[];
    bestPractices?: string[];
    relatedTools?: string[];
}
export interface ToolExample {
    title: string;
    description: string;
    input: Record<string, any>;
    expectedOutput?: Record<string, any>;
    notes?: string;
}
export interface CommonError {
    error: string;
    cause: string;
    solution: string;
}
export declare const toolDocumentation: Record<string, ToolDocumentation>;
export declare const parameterDocumentation: {
    detail: {
        description: string;
        type: string;
        values: {
            basic: string;
            standard: string;
            full: string;
        };
        examples: {
            value: string;
            useCase: string;
        }[];
    };
    includeSubData: {
        description: string;
        type: string;
        notes: string;
        examples: {
            value: boolean;
            useCase: string;
        }[];
    };
    limit: {
        description: string;
        type: string;
        constraints: {
            min: number;
            max: number;
            default: number;
        };
        notes: string;
        examples: {
            value: number;
            useCase: string;
        }[];
    };
    offset: {
        description: string;
        type: string;
        constraints: {
            min: number;
            default: number;
        };
        notes: string;
        examples: {
            value: number;
            useCase: string;
        }[];
    };
    dateFrom: {
        description: string;
        type: string;
        format: string;
        examples: {
            value: string;
            useCase: string;
        }[];
    };
    dateTo: {
        description: string;
        type: string;
        format: string;
        notes: string;
        examples: {
            value: string;
            useCase: string;
        }[];
    };
};
export declare const categoryDocumentation: {
    notes: {
        name: string;
        description: string;
        overview: string;
        commonWorkflows: {
            name: string;
            steps: string[];
        }[];
    };
    features: {
        name: string;
        description: string;
        overview: string;
        commonWorkflows: {
            name: string;
            steps: string[];
        }[];
    };
    companies: {
        name: string;
        description: string;
        overview: string;
        commonWorkflows: {
            name: string;
            steps: string[];
        }[];
    };
};
/**
 * Merge manual and generated documentation
 * Manual documentation takes precedence
 */
export declare function getMergedDocumentation(): Promise<Record<string, ToolDocumentation>>;