mcp-adr-analysis-server/dist/src/resources/project-status-resource.d.ts

MCP server for analyzing Architectural Decision Records and project architecture

/**
 * Project Status Resource
 * Provides comprehensive project status and health metrics
 */
import { ResourceGenerationResult } from './index.js';
export interface ProjectStatus {
    version: string;
    timestamp: string;
    overallHealth: 'excellent' | 'good' | 'fair' | 'poor';
    components: {
        tasks: any;
        research: any;
        rules: any;
    };
    metrics: {
        completionRate: number;
        qualityScore: number;
        resourceCoverage: number;
    };
}
/**
 * Generate comprehensive project status resource aggregating data from multiple sources.
 *
 * This function provides a holistic view of the project's current state by combining
 * task management, research documentation, and rule compliance metrics.
 *
 * @returns Promise resolving to resource generation result containing:
 *   - data: Complete project status including health metrics and component breakdown
 *   - contentType: "application/json"
 *   - lastModified: ISO timestamp of generation
 *   - cacheKey: Unique identifier for caching
 *   - ttl: Cache duration (120 seconds)
 *   - etag: Entity tag for cache validation
 *
 * @throws {McpAdrError} When resource generation fails due to:
 *   - Inability to generate todo/research/rules resources
 *   - Invalid data structure from component resources
 *   - Cache operation failures
 *
 * @example
 * ```typescript
 * const status = await generateProjectStatusResource();
 * console.log(`Project health: ${status.data.overallHealth}`);
 * console.log(`Completion rate: ${status.data.metrics.completionRate}%`);
 *
 * // Expected output structure:
 * {
 *   data: {
 *     version: "1.0.0",
 *     timestamp: "2025-10-12T17:00:00.000Z",
 *     overallHealth: "good",
 *     components: {
 *       tasks: { summary: { total: 10, completed: 7 } },
 *       research: { summary: { total: 5 } },
 *       rules: { summary: { enabled: 15, total: 20 } }
 *     },
 *     metrics: {
 *       completionRate: 70,
 *       qualityScore: 85,
 *       resourceCoverage: 35
 *     }
 *   },
 *   contentType: "application/json",
 *   cacheKey: "project-status:current",
 *   ttl: 120
 * }
 * ```
 *
 * @since v2.0.0
 * @see {@link generateTodoListResource} for task management data
 * @see {@link generateResearchIndexResource} for research documentation
 * @see {@link generateRuleCatalogResource} for rule compliance
 */
export declare function generateProjectStatusResource(): Promise<ResourceGenerationResult>;
//# sourceMappingURL=project-status-resource.d.ts.map