@prowi/deskcheck 0.1.0

package/build/core/types.d.ts

@@ -0,0 +1,268 @@
+/** Severity level assigned to a criterion (how important it is). */
+export type ModuleSeverity = "critical" | "high" | "medium" | "low";
+/** Severity level assigned to an individual finding. */
+export type FindingSeverity = "critical" | "warning" | "info";
+/** Claude model tier used for agent execution. */
+export type AgentModel = "haiku" | "sonnet" | "opus";
+/** How the source content is provided to executors. */
+export type ContextType = "diff" | "file" | "symbol";
+/** Lifecycle status of a deskcheck plan. */
+export type PlanStatus = "planning" | "ready" | "executing" | "complete";
+/** Lifecycle status of an individual deskcheck task. */
+export type TaskStatus = "pending" | "in_progress" | "complete" | "error";
+/** Whether results cover all tasks or only a subset. */
+export type ResultsStatus = "partial" | "complete";
+/** A criterion parsed from a markdown file in the criteria directory. */
+export interface ReviewModule {
+    /** Unique identifier, e.g. "architecture/dto-enforcement". */
+    id: string;
+    /** Relative file path, e.g. "deskcheck/criteria/architecture/dto-enforcement.md". */
+    file: string;
+    /** Human-readable description from frontmatter. */
+    description: string;
+    /** How important this criterion's findings are. */
+    severity: ModuleSeverity;
+    /** File glob patterns that determine which files this criterion checks. */
+    globs: string[];
+    /** Natural language instruction for how to split files into tasks. */
+    mode: string;
+    /** Claude model tier to use for executor agents. */
+    model: AgentModel;
+    /** The detective prompt (markdown body of the criterion) given to executor agents. */
+    prompt: string;
+}
+/** MCP server configuration for agent tool access. */
+export interface McpServerConfig {
+    /** Command to start the MCP server. */
+    command: string;
+    /** Command-line arguments. */
+    args?: string[];
+    /** Environment variables passed to the server process. */
+    env?: Record<string, string>;
+}
+/** Per-role agent configuration (planner, executor, evaluator). */
+export interface AgentRoleConfig {
+    /** Override the default model for this role. */
+    model?: AgentModel;
+    /** Additional tools beyond the shared set. */
+    additional_tools?: string[];
+    /** Additional MCP servers beyond the shared set. */
+    additional_mcp_servers?: Record<string, McpServerConfig>;
+}
+/** Top-level deskcheck tool configuration from .deskcheck/config.json. */
+export interface ReviewConfig {
+    /** Directory containing criterion markdown files. */
+    modules_dir: string;
+    /** Directory for storing deskcheck run results. */
+    storage_dir: string;
+    /** Port for the web UI server. Default: 3000. */
+    serve_port: number;
+    /** Shared configuration applied to all agent roles. */
+    shared: {
+        /** Tools available to all agents. */
+        allowed_tools: string[];
+        /** MCP servers available to all agents. */
+        mcp_servers: Record<string, McpServerConfig>;
+    };
+    /** Per-role agent configuration. */
+    agents: {
+        planner: AgentRoleConfig;
+        executor: AgentRoleConfig;
+        evaluator: AgentRoleConfig;
+    };
+}
+/** What is being reviewed — a diff, file, or symbol. */
+export interface ReviewSource {
+    /** The kind of content being reviewed. */
+    type: ContextType;
+    /** Target identifier: branch name (diff), file path (file), or symbol name (symbol). */
+    target: string;
+    /** Only for symbol mode — the file containing the symbol. */
+    file?: string;
+}
+/** A single review task assigned to an executor agent. */
+export interface ReviewTask {
+    /** Unique task identifier, e.g. "architecture--dto-enforcement-001". */
+    task_id: string;
+    /** Review module identifier, e.g. "architecture/dto-enforcement". */
+    review_id: string;
+    /** Relative path to the criterion file. */
+    review_file: string;
+    /** Files assigned to this task. */
+    files: string[];
+    /** Optional planner hint describing scope or focus area. */
+    hint: string | null;
+    /** Claude model tier for the executor agent. */
+    model: AgentModel;
+    /** Current lifecycle status. */
+    status: TaskStatus;
+    /** ISO 8601 timestamp when this task was created. */
+    created_at: string;
+    /** ISO 8601 timestamp when execution started. */
+    started_at: string | null;
+    /** ISO 8601 timestamp when execution completed. */
+    completed_at: string | null;
+    /** How context was provided to the executor (diff, file content, or symbol). */
+    context_type: ContextType;
+    /** The actual context content (pruneable after completion). */
+    context: string | null;
+    /** Only for symbol mode — the symbol being reviewed. */
+    symbol: string | null;
+    /** The detective prompt from the criterion (pruneable after completion). */
+    prompt: string | null;
+}
+/** Summary of a criterion's role in a plan. */
+export interface ModuleSummary {
+    /** Review module identifier. */
+    review_id: string;
+    /** Human-readable description from frontmatter. */
+    description: string;
+    /** Criterion severity level. */
+    severity: ModuleSeverity;
+    /** Claude model tier from frontmatter. */
+    model: AgentModel;
+    /** Number of tasks created for this criterion. */
+    task_count: number;
+    /** Files that matched this module's globs. */
+    matched_files: string[];
+}
+/** The complete deskcheck plan written to plan.json. */
+export interface ReviewPlan {
+    /** Unique plan identifier, e.g. "2026-03-19_143022". */
+    plan_id: string;
+    /** Human-readable name, e.g. "feature/order-rework vs develop". */
+    name: string;
+    /** What is being reviewed. */
+    source: ReviewSource;
+    /** Current lifecycle status. */
+    status: PlanStatus;
+    /** ISO 8601 timestamp when the plan was created. */
+    created_at: string;
+    /** ISO 8601 timestamp when planning was finalized. */
+    finalized_at: string | null;
+    /** ISO 8601 timestamp when execution started. */
+    started_at: string | null;
+    /** ISO 8601 timestamp when all tasks completed. */
+    completed_at: string | null;
+    /** Files that matched at least one criterion. */
+    matched_files: string[];
+    /** Files with no matching criterion (coverage gaps). */
+    unmatched_files: string[];
+    /** All tasks keyed by task_id. */
+    tasks: Record<string, ReviewTask>;
+    /** Per-module summaries keyed by review_id. */
+    modules: Record<string, ModuleSummary>;
+}
+/** Token usage and timing data from an executor agent run. */
+export interface TaskUsage {
+    input_tokens: number;
+    output_tokens: number;
+    cache_read_tokens: number;
+    cache_creation_tokens: number;
+    cost_usd: number;
+    duration_ms: number;
+    duration_api_ms: number;
+    num_turns: number;
+    model: string;
+}
+/** Aggregated token usage across all tasks in a run. */
+export interface TotalUsage {
+    input_tokens: number;
+    output_tokens: number;
+    cache_read_tokens: number;
+    cache_creation_tokens: number;
+    cost_usd: number;
+    duration_ms: number;
+    duration_api_ms: number;
+    num_turns: number;
+}
+/** A single finding produced by an executor agent. */
+export interface Finding {
+    /** How severe this finding is. */
+    severity: FindingSeverity;
+    /** File path where the issue was found. */
+    file: string;
+    /** Line number where the issue occurs, if applicable. */
+    line: number | null;
+    /** Description of the issue. */
+    description: string;
+    /** Suggested fix or improvement, if applicable. */
+    suggestion: string | null;
+}
+/** A finding enriched with its source module and task for by-file grouping. */
+export interface FileFinding extends Finding {
+    /** Which criterion produced this finding. */
+    review_id: string;
+    /** Which task produced this finding. */
+    task_id: string;
+}
+/** Results from a single completed task. */
+export interface TaskResult {
+    /** The task that produced these results. */
+    task_id: string;
+    /** The criterion that was applied. */
+    review_id: string;
+    /** Files that were reviewed. */
+    files: string[];
+    /** ISO 8601 timestamp when the task completed. */
+    completed_at: string;
+    /** Findings produced by the executor agent. */
+    findings: Finding[];
+    /** Token usage and timing from the executor agent. Null for legacy results. */
+    usage: TaskUsage | null;
+}
+/** Aggregated findings for a single criterion. */
+export interface ModuleFindings {
+    /** Review module identifier. */
+    review_id: string;
+    /** Human-readable description. */
+    description: string;
+    /** Criterion severity level. */
+    severity: ModuleSeverity;
+    /** Total number of tasks for this criterion. */
+    task_count: number;
+    /** Number of completed tasks. */
+    completed: number;
+    /** Aggregated finding counts by severity. */
+    counts: {
+        critical: number;
+        warning: number;
+        info: number;
+        total: number;
+    };
+    /** All findings from this module's tasks. */
+    findings: Finding[];
+}
+/** The complete deskcheck results written to results.json. */
+export interface ReviewResults {
+    /** Matches the plan_id from plan.json. */
+    plan_id: string;
+    /** Whether all tasks have completed. */
+    status: ResultsStatus;
+    /** ISO 8601 timestamp of the last update. */
+    updated_at: string;
+    /** Task completion tracking. */
+    completion: {
+        total: number;
+        completed: number;
+        pending: number;
+        in_progress: number;
+        errored: number;
+    };
+    /** Aggregated finding counts across all tasks. */
+    summary: {
+        total: number;
+        critical: number;
+        warning: number;
+        info: number;
+    };
+    /** Per-task results keyed by task_id. */
+    task_results: Record<string, TaskResult>;
+    /** Findings grouped by file path. */
+    by_file: Record<string, FileFinding[]>;
+    /** Findings grouped by criterion. */
+    by_module: Record<string, ModuleFindings>;
+    /** Aggregated token usage across all completed tasks. */
+    total_usage: TotalUsage;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/core/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAIA,oEAAoE;AACpE,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEpE,wDAAwD;AACxD,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,CAAC;AAE9D,kDAAkD;AAClD,MAAM,MAAM,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAC;AAErD,uDAAuD;AACvD,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAErD,4CAA4C;AAC5C,MAAM,MAAM,UAAU,GAAG,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,UAAU,CAAC;AAEzE,wDAAwD;AACxD,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,aAAa,GAAG,UAAU,GAAG,OAAO,CAAC;AAE1E,wDAAwD;AACxD,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,UAAU,CAAC;AAMnD,yEAAyE;AACzE,MAAM,WAAW,YAAY;IAC3B,8DAA8D;IAC9D,EAAE,EAAE,MAAM,CAAC;IACX,qFAAqF;IACrF,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,QAAQ,EAAE,cAAc,CAAC;IACzB,2EAA2E;IAC3E,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,KAAK,EAAE,UAAU,CAAC;IAClB,sFAAsF;IACtF,MAAM,EAAE,MAAM,CAAC;CAChB;AAMD,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,uCAAuC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,0DAA0D;IAC1D,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED,mEAAmE;AACnE,MAAM,WAAW,eAAe;IAC9B,gDAAgD;IAChD,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,8CAA8C;IAC9C,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B,oDAAoD;IACpD,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CAC1D;AAED,0EAA0E;AAC1E,MAAM,WAAW,YAAY;IAC3B,qDAAqD;IACrD,WAAW,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,UAAU,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,MAAM,EAAE;QACN,qCAAqC;QACrC,aAAa,EAAE,MAAM,EAAE,CAAC;QACxB,2CAA2C;QAC3C,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC9C,CAAC;IACF,oCAAoC;IACpC,MAAM,EAAE;QACN,OAAO,EAAE,eAAe,CAAC;QACzB,QAAQ,EAAE,eAAe,CAAC;QAC1B,SAAS,EAAE,eAAe,CAAC;KAC5B,CAAC;CACH;AAMD,wDAAwD;AACxD,MAAM,WAAW,YAAY;IAC3B,0CAA0C;IAC1C,IAAI,EAAE,WAAW,CAAC;IAClB,wFAAwF;IACxF,MAAM,EAAE,MAAM,CAAC;IACf,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,0DAA0D;AAC1D,MAAM,WAAW,UAAU;IACzB,wEAAwE;IACxE,OAAO,EAAE,MAAM,CAAC;IAChB,qEAAqE;IACrE,SAAS,EAAE,MAAM,CAAC;IAClB,2CAA2C;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,4DAA4D;IAC5D,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,gDAAgD;IAChD,KAAK,EAAE,UAAU,CAAC;IAClB,gCAAgC;IAChC,MAAM,EAAE,UAAU,CAAC;IACnB,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAC;IACnB,iDAAiD;IACjD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,mDAAmD;IACnD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,gFAAgF;IAChF,YAAY,EAAE,WAAW,CAAC;IAC1B,+DAA+D;IAC/D,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,wDAAwD;IACxD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,4EAA4E;IAC5E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,+CAA+C;AAC/C,MAAM,WAAW,aAAa;IAC5B,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,QAAQ,EAAE,cAAc,CAAC;IACzB,0CAA0C;IAC1C,KAAK,EAAE,UAAU,CAAC;IAClB,kDAAkD;IAClD,UAAU,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,aAAa,EAAE,MAAM,EAAE,CAAC;CACzB;AAED,wDAAwD;AACxD,MAAM,WAAW,UAAU;IACzB,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;IAChB,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,MAAM,EAAE,YAAY,CAAC;IACrB,gCAAgC;IAChC,MAAM,EAAE,UAAU,CAAC;IACnB,oDAAoD;IACpD,UAAU,EAAE,MAAM,CAAC;IACnB,sDAAsD;IACtD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,iDAAiD;IACjD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,mDAAmD;IACnD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,iDAAiD;IACjD,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,wDAAwD;IACxD,eAAe,EAAE,MAAM,EAAE,CAAC;IAE1B,kCAAkC;IAClC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAClC,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACxC;AAMD,8DAA8D;AAC9D,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wDAAwD;AACxD,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;CACnB;AAMD,sDAAsD;AACtD,MAAM,WAAW,OAAO;IACtB,kCAAkC;IAClC,QAAQ,EAAE,eAAe,CAAC;IAC1B,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,mDAAmD;IACnD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,+EAA+E;AAC/E,MAAM,WAAW,WAAY,SAAQ,OAAO;IAC1C,6CAA6C;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,4CAA4C;AAC5C,MAAM,WAAW,UAAU;IACzB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,gCAAgC;IAChC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,kDAAkD;IAClD,YAAY,EAAE,MAAM,CAAC;IACrB,+CAA+C;IAC/C,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,+EAA+E;IAC/E,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;CACzB;AAED,kDAAkD;AAClD,MAAM,WAAW,cAAc;IAC7B,gCAAgC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,gCAAgC;IAChC,QAAQ,EAAE,cAAc,CAAC;IACzB,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;IACnB,iCAAiC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,6CAA6C;IAC7C,MAAM,EAAE;QACN,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,6CAA6C;IAC7C,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,8DAA8D;AAC9D,MAAM,WAAW,aAAa;IAC5B,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,wCAAwC;IACxC,MAAM,EAAE,aAAa,CAAC;IACtB,6CAA6C;IAC7C,UAAU,EAAE,MAAM,CAAC;IAEnB,gCAAgC;IAChC,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,MAAM,CAAC;QAClB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IAEF,kDAAkD;IAClD,OAAO,EAAE;QACP,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IAEF,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACzC,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IACvC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC1C,yDAAyD;IACzD,WAAW,EAAE,UAAU,CAAC;CACzB"}

package/build/core/types.js

@@ -0,0 +1,5 @@
+// =============================================================================
+// Common Union Types
+// =============================================================================
+export {};
+//# sourceMappingURL=types.js.map

package/build/core/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/core/types.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,qBAAqB;AACrB,gFAAgF"}

package/build/mcp/tools.d.ts

@@ -0,0 +1,10 @@
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { ReviewConfig } from "../core/types.js";
+/**
+ * Register all review MCP tools on the given server.
+ *
+ * Each tool wraps core business logic (storage, module discovery, glob matching)
+ * and exposes it over the MCP protocol with Zod-validated input schemas.
+ */
+export declare function registerReviewTools(server: McpServer, config: ReviewConfig, projectRoot: string): void;
+//# sourceMappingURL=tools.d.ts.map

package/build/mcp/tools.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.d.ts","sourceRoot":"","sources":["../../src/mcp/tools.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAEzE,OAAO,KAAK,EAAE,YAAY,EAAuB,MAAM,kBAAkB,CAAC;AAM1E;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,SAAS,EACjB,MAAM,EAAE,YAAY,EACpB,WAAW,EAAE,MAAM,GAClB,IAAI,CAoYN"}

package/build/mcp/tools.js

@@ -0,0 +1,354 @@
+import path from "node:path";
+import { z } from "zod";
+import { ReviewStorage } from "../core/storage.js";
+import { extractContext } from "../core/context-extractor.js";
+import { discoverModules, parseModule } from "../core/module-parser.js";
+import { findMatchingModules } from "../core/glob-matcher.js";
+/**
+ * Register all review MCP tools on the given server.
+ *
+ * Each tool wraps core business logic (storage, module discovery, glob matching)
+ * and exposes it over the MCP protocol with Zod-validated input schemas.
+ */
+export function registerReviewTools(server, config, projectRoot) {
+    const storage = new ReviewStorage(path.resolve(projectRoot, config.storage_dir));
+    const modulesDir = path.resolve(projectRoot, config.modules_dir);
+    // ---------------------------------------------------------------------------
+    // 1. review_status — health check
+    // ---------------------------------------------------------------------------
+    server.registerTool("review_status", {
+        description: "Returns the status of the deskcheck MCP server.",
+    }, () => {
+        return {
+            content: [{
+                    type: "text",
+                    text: JSON.stringify({ status: "ok", version: "0.1.0" }, null, 2),
+                }],
+        };
+    });
+    // ---------------------------------------------------------------------------
+    // 2. start_review_plan — create a new review plan
+    // ---------------------------------------------------------------------------
+    server.registerTool("start_review_plan", {
+        description: "Create a new review plan. Returns the plan object with its generated plan_id.",
+        inputSchema: {
+            name: z.string().describe("Human-readable name for the review plan"),
+            source_type: z
+                .enum(["diff", "file", "symbol"])
+                .describe("How source content is provided: diff, file, or symbol"),
+            source_target: z
+                .string()
+                .describe("Target identifier: branch/ref for diff, file path for file, symbol name for symbol"),
+            source_file: z
+                .string()
+                .optional()
+                .describe("File containing the symbol (only for symbol mode)"),
+        },
+    }, ({ name, source_type, source_target, source_file }) => {
+        try {
+            const plan = storage.createPlan(name, {
+                type: source_type,
+                target: source_target,
+                file: source_file,
+            });
+            return {
+                content: [{ type: "text", text: JSON.stringify(plan, null, 2) }],
+            };
+        }
+        catch (error) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                    }],
+                isError: true,
+            };
+        }
+    });
+    // ---------------------------------------------------------------------------
+    // 3. get_review_files_matching_paths — discover modules matching files
+    // ---------------------------------------------------------------------------
+    server.registerTool("get_review_files_matching_paths", {
+        description: "Discover which criteria match a set of file paths. Returns matches without the full prompt body.",
+        inputSchema: {
+            files: z
+                .array(z.string())
+                .describe("Array of file paths to match against criterion globs"),
+        },
+    }, ({ files }) => {
+        try {
+            const modules = discoverModules(modulesDir);
+            const matches = findMatchingModules(files, modules);
+            const result = matches.map((match) => ({
+                review_id: match.module.id,
+                review_file: match.module.file,
+                description: match.module.description,
+                severity: match.module.severity,
+                globs: match.module.globs,
+                mode: match.module.mode,
+                model: match.module.model,
+                matched_files: match.matchedFiles,
+            }));
+            return {
+                content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
+            };
+        }
+        catch (error) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                    }],
+                isError: true,
+            };
+        }
+    });
+    // ---------------------------------------------------------------------------
+    // 4. create_review_task — add a task to a plan
+    // ---------------------------------------------------------------------------
+    server.registerTool("create_review_task", {
+        description: "Create a review task within a plan. The task_id is auto-generated from the review_id.",
+        inputSchema: {
+            plan_id: z.string().describe("The plan ID to add the task to"),
+            review_id: z
+                .string()
+                .describe('Review module identifier, e.g. "architecture/dto-enforcement"'),
+            review_file: z
+                .string()
+                .describe("Relative path to the criterion markdown file"),
+            files: z
+                .array(z.string())
+                .describe("Files assigned to this task"),
+            hint: z
+                .string()
+                .optional()
+                .describe("Optional planner hint describing scope or focus area"),
+            model: z
+                .enum(["haiku", "sonnet", "opus"])
+                .describe("Claude model tier for the executor agent"),
+        },
+    }, ({ plan_id, review_id, review_file, files, hint, model }) => {
+        try {
+            const task = storage.addTask(plan_id, {
+                review_id,
+                review_file,
+                files,
+                hint: hint ?? null,
+                model,
+            });
+            return {
+                content: [{ type: "text", text: JSON.stringify(task, null, 2) }],
+            };
+        }
+        catch (error) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                    }],
+                isError: true,
+            };
+        }
+    });
+    // ---------------------------------------------------------------------------
+    // 5. finish_planning — finalize the plan
+    // ---------------------------------------------------------------------------
+    server.registerTool("finish_planning", {
+        description: 'Finalize a review plan, setting its status to "ready" for execution.',
+        inputSchema: {
+            plan_id: z.string().describe("The plan ID to finalize"),
+        },
+    }, ({ plan_id }) => {
+        try {
+            const plan = storage.finalizePlan(plan_id);
+            return {
+                content: [{ type: "text", text: JSON.stringify(plan, null, 2) }],
+            };
+        }
+        catch (error) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                    }],
+                isError: true,
+            };
+        }
+    });
+    // ---------------------------------------------------------------------------
+    // 6. get_pending_review_tasks — list tasks ready for execution
+    // ---------------------------------------------------------------------------
+    server.registerTool("get_pending_review_tasks", {
+        description: "Return tasks eligible for execution: pending tasks and stale in_progress tasks (older than 5 minutes).",
+        inputSchema: {
+            plan_id: z.string().describe("The plan ID to query"),
+        },
+    }, ({ plan_id }) => {
+        try {
+            const tasks = storage.getPendingTasks(plan_id);
+            return {
+                content: [{ type: "text", text: JSON.stringify(tasks, null, 2) }],
+            };
+        }
+        catch (error) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                    }],
+                isError: true,
+            };
+        }
+    });
+    // ---------------------------------------------------------------------------
+    // 7. start_review — claim a task and return context for executor
+    // ---------------------------------------------------------------------------
+    server.registerTool("start_review", {
+        description: "Claim a review task and return everything the executor needs: context (diff/file/symbol content), the criterion prompt, and task metadata.",
+        inputSchema: {
+            plan_id: z.string().describe("The plan ID"),
+            task_id: z.string().describe("The task ID to claim"),
+        },
+    }, ({ plan_id, task_id }) => {
+        try {
+            const plan = storage.getPlan(plan_id);
+            const task = plan.tasks[task_id];
+            if (!task) {
+                return {
+                    content: [{
+                            type: "text",
+                            text: `Error: Task "${task_id}" not found in plan "${plan_id}"`,
+                        }],
+                    isError: true,
+                };
+            }
+            // Extract context based on source type
+            const symbol = plan.source.type === "symbol" ? plan.source.target : undefined;
+            const extracted = extractContext(plan.source.type, plan.source.target, task.files, projectRoot, symbol);
+            // Read the criterion prompt
+            const moduleFilePath = path.resolve(projectRoot, task.review_file);
+            const reviewModule = parseModule(moduleFilePath, path.resolve(projectRoot, config.modules_dir));
+            // Claim the task via storage
+            const claimedTask = storage.claimTask(plan_id, task_id, {
+                contextType: extracted.contextType,
+                content: extracted.content,
+                symbol: extracted.symbol ?? undefined,
+                prompt: reviewModule.prompt,
+            });
+            return {
+                content: [{
+                        type: "text",
+                        text: JSON.stringify({
+                            task_id: claimedTask.task_id,
+                            review_id: claimedTask.review_id,
+                            files: claimedTask.files,
+                            hint: claimedTask.hint,
+                            model: claimedTask.model,
+                            context_type: claimedTask.context_type,
+                            context: claimedTask.context,
+                            symbol: claimedTask.symbol,
+                            prompt: claimedTask.prompt,
+                        }, null, 2),
+                    }],
+            };
+        }
+        catch (error) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                    }],
+                isError: true,
+            };
+        }
+    });
+    // ---------------------------------------------------------------------------
+    // 8. finish_review — complete a task with findings
+    // ---------------------------------------------------------------------------
+    server.registerTool("finish_review", {
+        description: "Complete a review task by submitting findings. Updates both plan.json and results.json.",
+        inputSchema: {
+            plan_id: z.string().describe("The plan ID"),
+            task_id: z.string().describe("The task ID to complete"),
+            findings: z
+                .array(z.object({
+                severity: z
+                    .enum(["critical", "warning", "info"])
+                    .describe("Finding severity"),
+                file: z.string().describe("File path where the issue was found"),
+                line: z
+                    .number()
+                    .nullable()
+                    .optional()
+                    .describe("Line number, if applicable"),
+                description: z.string().describe("Description of the issue"),
+                suggestion: z
+                    .string()
+                    .nullable()
+                    .optional()
+                    .describe("Suggested fix, if applicable"),
+            }))
+                .describe("Array of findings from the review"),
+        },
+    }, ({ plan_id, task_id, findings }) => {
+        try {
+            const normalizedFindings = findings.map((f) => ({
+                severity: f.severity,
+                file: f.file,
+                line: f.line ?? null,
+                description: f.description,
+                suggestion: f.suggestion ?? null,
+            }));
+            storage.completeTask(plan_id, task_id, normalizedFindings);
+            const plan = storage.getPlan(plan_id);
+            const task = plan.tasks[task_id];
+            return {
+                content: [{
+                        type: "text",
+                        text: JSON.stringify({
+                            task_id: task.task_id,
+                            status: task.status,
+                            completed_at: task.completed_at,
+                            findings_count: normalizedFindings.length,
+                            plan_status: plan.status,
+                        }, null, 2),
+                    }],
+            };
+        }
+        catch (error) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                    }],
+                isError: true,
+            };
+        }
+    });
+    // ---------------------------------------------------------------------------
+    // 9. get_review_results — aggregated results
+    // ---------------------------------------------------------------------------
+    server.registerTool("get_review_results", {
+        description: "Return aggregated review results including findings grouped by file and module.",
+        inputSchema: {
+            plan_id: z.string().describe("The plan ID to get results for"),
+        },
+    }, ({ plan_id }) => {
+        try {
+            const results = storage.getResults(plan_id);
+            return {
+                content: [{ type: "text", text: JSON.stringify(results, null, 2) }],
+            };
+        }
+        catch (error) {
+            return {
+                content: [{
+                        type: "text",
+                        text: `Error: ${error instanceof Error ? error.message : String(error)}`,
+                    }],
+                isError: true,
+            };
+        }
+    });
+}
+//# sourceMappingURL=tools.js.map