@lumenflow/mcp 2.11.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 HellmAI
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/bin.d.ts

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+/**
+ * @file bin.ts
+ * @description CLI entry point for @lumenflow/mcp
+ *
+ * WU-1412: MCP server runs via npx @lumenflow/mcp over stdio
+ *
+ * Usage:
+ *   npx @lumenflow/mcp
+ *
+ * Environment variables:
+ *   LUMENFLOW_PROJECT_ROOT - Project root directory
+ *   LUMENFLOW_MCP_LOG_LEVEL - Log level (debug, info, warn, error)
+ */
+export {};

package/dist/bin.js

@@ -0,0 +1,68 @@
+#!/usr/bin/env node
+/**
+ * @file bin.ts
+ * @description CLI entry point for @lumenflow/mcp
+ *
+ * WU-1412: MCP server runs via npx @lumenflow/mcp over stdio
+ *
+ * Usage:
+ *   npx @lumenflow/mcp
+ *
+ * Environment variables:
+ *   LUMENFLOW_PROJECT_ROOT - Project root directory
+ *   LUMENFLOW_MCP_LOG_LEVEL - Log level (debug, info, warn, error)
+ */
+import { createMcpServer } from './server.js';
+/**
+ * Log to stderr (stdout is reserved for MCP protocol)
+ */
+function log(message) {
+    process.stderr.write(`${message}\n`);
+}
+/**
+ * Main entry point
+ */
+async function main() {
+    const projectRoot = process.env.LUMENFLOW_PROJECT_ROOT;
+    const logLevel = process.env.LUMENFLOW_MCP_LOG_LEVEL;
+    const server = createMcpServer({
+        projectRoot,
+        logLevel,
+    });
+    // Log startup info to stderr (stdout is for MCP protocol)
+    if (logLevel === 'debug' || logLevel === 'info') {
+        log(`[@lumenflow/mcp] Starting MCP server...`);
+        log(`[@lumenflow/mcp] Project root: ${server.config.projectRoot}`);
+        log(`[@lumenflow/mcp] Log level: ${server.config.logLevel}`);
+        log(`[@lumenflow/mcp] Tools: ${server
+            .listTools()
+            .map((t) => t.name)
+            .join(', ')}`);
+        log(`[@lumenflow/mcp] Resources: ${server
+            .listResources()
+            .map((r) => r.uri)
+            .join(', ')}`);
+    }
+    // Handle process signals - wrap async handlers to avoid unhandled rejections
+    const handleShutdown = (signal) => {
+        log(`[@lumenflow/mcp] Received ${signal}, shutting down...`);
+        server
+            .stop()
+            .then(() => {
+            process.exit(0);
+        })
+            .catch((err) => {
+            log(`[@lumenflow/mcp] Error during shutdown: ${err instanceof Error ? err.message : String(err)}`);
+            process.exit(1);
+        });
+    };
+    process.on('SIGINT', () => handleShutdown('SIGINT'));
+    process.on('SIGTERM', () => handleShutdown('SIGTERM'));
+    // Start the server
+    await server.start();
+}
+// Run main
+main().catch((err) => {
+    log(`[@lumenflow/mcp] Fatal error: ${err instanceof Error ? err.message : String(err)}`);
+    process.exit(1);
+});

package/dist/cli-runner.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @file cli-runner.ts
+ * @description CLI runner utility for shelling out to LumenFlow CLI commands
+ *
+ * WU-1412: MCP server uses CLI shell-out for write operations (wu_create, wu_claim, wu_done, gates_run)
+ * Read operations use @lumenflow/core directly for better performance and type safety.
+ *
+ * This module provides a safe, consistent way to execute CLI commands with:
+ * - Timeout support
+ * - Project root configuration
+ * - Proper error handling
+ * - Structured output
+ */
+/**
+ * CLI runner options
+ */
+export interface CliRunnerOptions {
+    /** Working directory for command execution (defaults to process.cwd()) */
+    projectRoot?: string;
+    /** Command timeout in milliseconds (defaults to 120000 = 2 minutes) */
+    timeout?: number;
+    /** Additional environment variables */
+    env?: Record<string, string>;
+}
+/**
+ * CLI runner result
+ */
+export interface CliRunnerResult {
+    /** Whether the command succeeded (exit code 0) */
+    success: boolean;
+    /** Standard output */
+    stdout: string;
+    /** Standard error output */
+    stderr: string;
+    /** Exit code (if available) */
+    exitCode?: number;
+    /** Error object (if command failed) */
+    error?: {
+        message: string;
+        code?: string | number;
+    };
+}
+/**
+ * Execute a LumenFlow CLI command
+ *
+ * @param command - CLI command to execute (e.g., 'wu:status', 'wu:claim', 'gates')
+ * @param args - Command arguments
+ * @param options - Execution options
+ * @returns Command execution result
+ *
+ * @example
+ * // Get WU status
+ * const result = await runCliCommand('wu:status', ['--id', 'WU-1412', '--json']);
+ *
+ * @example
+ * // Run gates
+ * const result = await runCliCommand('gates', ['--docs-only']);
+ */
+export declare function runCliCommand(command: string, args?: string[], options?: CliRunnerOptions): Promise<CliRunnerResult>;
+/**
+ * Parse JSON output from a CLI command
+ *
+ * @param result - CLI runner result
+ * @returns Parsed JSON data or null if parsing fails
+ */
+export declare function parseJsonOutput<T>(result: CliRunnerResult): T | null;

package/dist/cli-runner.js

@@ -0,0 +1,94 @@
+/**
+ * @file cli-runner.ts
+ * @description CLI runner utility for shelling out to LumenFlow CLI commands
+ *
+ * WU-1412: MCP server uses CLI shell-out for write operations (wu_create, wu_claim, wu_done, gates_run)
+ * Read operations use @lumenflow/core directly for better performance and type safety.
+ *
+ * This module provides a safe, consistent way to execute CLI commands with:
+ * - Timeout support
+ * - Project root configuration
+ * - Proper error handling
+ * - Structured output
+ */
+import { execFile } from 'node:child_process';
+import { promisify } from 'node:util';
+const execFileAsync = promisify(execFile);
+/**
+ * Default timeout for CLI commands (2 minutes)
+ */
+const DEFAULT_TIMEOUT_MS = 120000;
+/**
+ * Execute a LumenFlow CLI command
+ *
+ * @param command - CLI command to execute (e.g., 'wu:status', 'wu:claim', 'gates')
+ * @param args - Command arguments
+ * @param options - Execution options
+ * @returns Command execution result
+ *
+ * @example
+ * // Get WU status
+ * const result = await runCliCommand('wu:status', ['--id', 'WU-1412', '--json']);
+ *
+ * @example
+ * // Run gates
+ * const result = await runCliCommand('gates', ['--docs-only']);
+ */
+export async function runCliCommand(command, args = [], options = {}) {
+    const projectRoot = options.projectRoot || process.cwd();
+    const timeout = options.timeout ?? DEFAULT_TIMEOUT_MS;
+    // Use pnpm to run the command
+    const pnpmPath = 'pnpm';
+    const pnpmArgs = [command, ...args];
+    try {
+        const { stdout, stderr } = await execFileAsync(pnpmPath, pnpmArgs, {
+            cwd: projectRoot,
+            timeout,
+            env: {
+                ...process.env,
+                ...options.env,
+                // Ensure we're in non-interactive mode
+                CI: 'true',
+                // Pass through project root
+                LUMENFLOW_PROJECT_ROOT: projectRoot,
+            },
+            maxBuffer: 10 * 1024 * 1024, // 10MB buffer
+        });
+        return {
+            success: true,
+            stdout: stdout.trim(),
+            stderr: stderr.trim(),
+            exitCode: 0,
+        };
+    }
+    catch (err) {
+        const error = err;
+        return {
+            success: false,
+            stdout: error.stdout?.trim() || '',
+            stderr: error.stderr?.trim() || '',
+            exitCode: typeof error.code === 'number' ? error.code : 1,
+            error: {
+                message: error.message,
+                code: error.code,
+            },
+        };
+    }
+}
+/**
+ * Parse JSON output from a CLI command
+ *
+ * @param result - CLI runner result
+ * @returns Parsed JSON data or null if parsing fails
+ */
+export function parseJsonOutput(result) {
+    if (!result.success || !result.stdout) {
+        return null;
+    }
+    try {
+        return JSON.parse(result.stdout);
+    }
+    catch {
+        return null;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @lumenflow/mcp - MCP stdio server for LumenFlow workflow framework
+ * @module @lumenflow/mcp
+ *
+ * WU-1412: Provides MCP server with LumenFlow tools and resources.
+ *
+ * Tools:
+ * - context_get: Get current LumenFlow context
+ * - wu_list: List all Work Units
+ * - wu_status: Get WU status
+ * - wu_create: Create a new WU
+ * - wu_claim: Claim a WU
+ * - wu_done: Complete a WU
+ * - gates_run: Run quality gates
+ *
+ * Resources:
+ * - lumenflow://context: Current context
+ * - lumenflow://wu/{id}: WU by ID
+ * - lumenflow://backlog: Current backlog
+ *
+ * @example
+ * ```typescript
+ * import { createMcpServer } from '@lumenflow/mcp';
+ *
+ * const server = createMcpServer({
+ *   projectRoot: '/path/to/project',
+ *   logLevel: 'info',
+ * });
+ *
+ * await server.start();
+ * ```
+ */
+export { createMcpServer, type McpServer, type McpServerConfig, type LogLevel } from './server.js';
+export { allTools, contextGetTool, wuListTool, wuStatusTool, wuCreateTool, wuClaimTool, wuDoneTool, gatesRunTool, type ToolDefinition, type ToolResult, } from './tools.js';
+export { allResources, staticResources, resourceTemplates, contextResource, wuResource, backlogResource, type ResourceDefinition, type ResourceResult, } from './resources.js';
+export { runCliCommand, parseJsonOutput, type CliRunnerOptions, type CliRunnerResult, } from './cli-runner.js';

package/dist/index.js

@@ -0,0 +1,40 @@
+/**
+ * @lumenflow/mcp - MCP stdio server for LumenFlow workflow framework
+ * @module @lumenflow/mcp
+ *
+ * WU-1412: Provides MCP server with LumenFlow tools and resources.
+ *
+ * Tools:
+ * - context_get: Get current LumenFlow context
+ * - wu_list: List all Work Units
+ * - wu_status: Get WU status
+ * - wu_create: Create a new WU
+ * - wu_claim: Claim a WU
+ * - wu_done: Complete a WU
+ * - gates_run: Run quality gates
+ *
+ * Resources:
+ * - lumenflow://context: Current context
+ * - lumenflow://wu/{id}: WU by ID
+ * - lumenflow://backlog: Current backlog
+ *
+ * @example
+ * ```typescript
+ * import { createMcpServer } from '@lumenflow/mcp';
+ *
+ * const server = createMcpServer({
+ *   projectRoot: '/path/to/project',
+ *   logLevel: 'info',
+ * });
+ *
+ * await server.start();
+ * ```
+ */
+// Server
+export { createMcpServer } from './server.js';
+// Tools
+export { allTools, contextGetTool, wuListTool, wuStatusTool, wuCreateTool, wuClaimTool, wuDoneTool, gatesRunTool, } from './tools.js';
+// Resources
+export { allResources, staticResources, resourceTemplates, contextResource, wuResource, backlogResource, } from './resources.js';
+// CLI Runner
+export { runCliCommand, parseJsonOutput, } from './cli-runner.js';

package/dist/resources.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @file resources.ts
+ * @description MCP resource implementations for LumenFlow
+ *
+ * WU-1412: Resources available: context, wu/{id}, backlog
+ *
+ * Resources provide read access to LumenFlow data via URI patterns.
+ */
+/**
+ * Resource definition
+ */
+export interface ResourceDefinition {
+    /** Static resource URI (for fixed resources) */
+    uri?: string;
+    /** URI template (for parameterized resources) */
+    uriTemplate?: string;
+    /** Resource name */
+    name: string;
+    /** Resource description */
+    description: string;
+    /** MIME type of the resource content */
+    mimeType: string;
+    /** Fetch the resource content */
+    fetch: (uri: string, options?: {
+        projectRoot?: string;
+    }) => Promise<ResourceResult>;
+}
+/**
+ * Resource result
+ */
+export interface ResourceResult {
+    success: boolean;
+    content?: string;
+    error?: string;
+}
+/**
+ * context - Current LumenFlow context
+ */
+export declare const contextResource: ResourceDefinition;
+/**
+ * wu/{id} - WU specification by ID
+ */
+export declare const wuResource: ResourceDefinition;
+/**
+ * backlog - Current backlog state
+ * Reads the backlog.md file directly (generated by LumenFlow CLI)
+ */
+export declare const backlogResource: ResourceDefinition;
+/**
+ * All static resources (fixed URIs)
+ */
+export declare const staticResources: ResourceDefinition[];
+/**
+ * All resource templates (parameterized URIs)
+ */
+export declare const resourceTemplates: ResourceDefinition[];
+/**
+ * All resources
+ */
+export declare const allResources: ResourceDefinition[];