imcp 0.1.4 → 0.1.6

package/.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Node.js CI
+
+on:
+  pull_request:
+    branches: [main] # Or your default branch
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x] # Specify Node.js versions to test against
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build project
+        run: npm run build

package/README.md

@@ -8,18 +8,22 @@ IMCP allows you to:
 
 - Discover and install available MCP servers to your local agents
 - Run a local UI interface with simple click experience to manage MCP servers
-- (in progress) Distribute your own MCP servers to others
+- Distribute your own MCP servers to others
 
 ## Get started
+
 - Quick usage with latest version
+
 ```
 npx -y imcp@latest serve
 ```
 
 - Or install it globally
+
 ```bash
 npm install -g imcp
 ```
+
 ```
 imcp serve
 ```
@@ -35,22 +39,35 @@ imcp serve
 Starts a local web interface for managing MCP servers.
 
 ```bash
-imcp serve [options]
+npx -y imcp@latest serve [options]
 ```
 
 Options:
+
 - `-p, --port <port>`: Port to run the server on (default: 3000)
 - `-f, --feed-file <filepath>`: Path to a custom feed configuration file
+- `-s, --schema-directory <schemaDir>`: Path to a directory containing adhoc schema files
 
 Example:
+
 ```bash
 # Start the web interface on port 8080
-imcp serve --port 8080
+npx -y imcp@latest serve --port 8080
 
 # Start with a custom feed configuration file
-imcp serve --feed-file ./custom-feed.json
+npx -y imcp@latest serve --feed-file ./custom-feed.json
+
+# Start with a custom feed configuration file and adhoc schema files.
+npx -y imcp@latest serve --feed-file ./custom-feed.json --schema-directory ./feeds/schemas/ai-coder-tools
 ```
 
+## MCP Installation and Publish
+
+For details on how to install and publish MCP servers, please refer to the following documents:
+
+- [Installation Guide](wiki/Installation.md)
+- [Publishing Guide](wiki/Publish.md)
+
 ## License
 
 MIT

package/dist/cli/commands/start.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function createStartCommand(): Command;

package/dist/cli/commands/start.js

@@ -0,0 +1,32 @@
+import { Command } from 'commander';
+import { startWebServer } from '../../web/server.js';
+import { mcpManager } from '../../core/MCPManager.js';
+export function createStartCommand() {
+    return new Command('start')
+        .description('Start local web interface')
+        .option('-p, --port <port>', 'Port to run the server on', '3000')
+        .action(async (options) => {
+        try {
+            // Sync feeds before start the local UI
+            await mcpManager.syncFeeds();
+            // Ensure MCP manager is initialized before starting the web server
+            await mcpManager.initialize();
+            const port = parseInt(options.port, 10);
+            if (isNaN(port) || port < 1 || port > 65535) {
+                throw new Error('Invalid port number');
+            }
+            await startWebServer(port);
+            // The server is running, keep the process alive
+            process.on('SIGINT', () => {
+                console.log('\nShutting down server...');
+                process.exit(0);
+            });
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            console.error('Failed to start web server:', message);
+            process.exit(1);
+        }
+    });
+}
+//# sourceMappingURL=start.js.map

package/dist/cli/commands/sync.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function createSyncCommand(): Command;

package/dist/cli/commands/sync.js

@@ -0,0 +1,17 @@
+import { Command } from 'commander';
+import { serverService } from '../../services/ServerService.js';
+export function createSyncCommand() {
+    return new Command('sync')
+        .description('Sync MCP server configurations from remote feed source')
+        .action(async () => {
+        try {
+            await serverService.syncFeeds();
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : 'Unknown error';
+            console.error('Error syncing configurations:', message);
+            process.exit(1);
+        }
+    });
+}
+//# sourceMappingURL=sync.js.map

package/dist/core/ConfigurationLoader.d.ts

@@ -0,0 +1,32 @@
+import { MCPConfiguration } from './types.js';
+export declare class ConfigurationLoader {
+    /**
+     * Updates the installed status for a server and client combination
+     */
+    private static updateServerInstalledStatus;
+    /**
+     * Removes a client's status from a server
+     */
+    private static removeClientStatus;
+    /**
+     * Synchronizes server categories with client MCP settings.
+     * Uses clientMCPSettings as source of truth for installation status.
+     */
+    static syncServerCategoriesWithClientSettings(configuration: MCPConfiguration): MCPConfiguration;
+    /**
+     * Initializes installation status for a feed configuration
+     */
+    private static initializeInstallationStatus;
+    /**
+     * Synchronizes server categories with feeds
+     */
+    private static syncServerCategoriesWithFeeds;
+    /**
+     * Loads feed configurations into the MCP configuration
+     */
+    static loadFeedsIntoConfiguration(configuration: MCPConfiguration, feedFile?: string): Promise<MCPConfiguration>;
+    /**
+     * Loads MCP client settings into the configuration
+     */
+    static loadClientMCPSettings(configuration: MCPConfiguration): Promise<MCPConfiguration>;
+}

package/dist/core/ConfigurationLoader.js

@@ -0,0 +1,236 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { LOCAL_FEEDS_DIR, SUPPORTED_CLIENTS } from './constants.js';
+import { Logger } from '../utils/logger.js';
+import { readJsonFile } from '../utils/clientUtils.js';
+export class ConfigurationLoader {
+    /**
+     * Updates the installed status for a server and client combination
+     */
+    static updateServerInstalledStatus(serverStatus, clientName, operationStatus) {
+        if (!serverStatus.installedStatus) {
+            serverStatus.installedStatus = {};
+        }
+        serverStatus.installedStatus[clientName] = operationStatus;
+    }
+    /**
+     * Removes a client's status from a server
+     */
+    static removeClientStatus(serverStatus, clientName) {
+        if (serverStatus.installedStatus && serverStatus.installedStatus[clientName]) {
+            delete serverStatus.installedStatus[clientName];
+        }
+    }
+    /**
+     * Synchronizes server categories with client MCP settings.
+     * Uses clientMCPSettings as source of truth for installation status.
+     */
+    static syncServerCategoriesWithClientSettings(configuration) {
+        if (!configuration.clientMCPSettings) {
+            return configuration;
+        }
+        configuration.localServerCategories = configuration.localServerCategories.map(category => {
+            if (!category.installationStatus?.serversStatus) {
+                return category;
+            }
+            const updatedServerStatus = { ...category.installationStatus.serversStatus };
+            const clientSettings = configuration.clientMCPSettings;
+            for (const [clientName, settings] of Object.entries(clientSettings)) {
+                const clientServers = clientName === 'GithubCopilot'
+                    ? settings.servers || {}
+                    : settings.mcpServers || {};
+                Object.keys(updatedServerStatus).forEach(serverName => {
+                    if (clientServers[serverName]) {
+                        if (!updatedServerStatus[serverName].installedStatus[clientName]) {
+                            const operationStatus = {
+                                status: 'completed',
+                                type: 'install',
+                                target: 'server',
+                                message: `Server ${serverName} is configured for client ${clientName}`
+                            };
+                            ConfigurationLoader.updateServerInstalledStatus(updatedServerStatus[serverName], clientName, operationStatus);
+                        }
+                    }
+                    else {
+                        ConfigurationLoader.removeClientStatus(updatedServerStatus[serverName], clientName);
+                    }
+                });
+            }
+            return {
+                ...category,
+                installationStatus: {
+                    ...category.installationStatus,
+                    serversStatus: updatedServerStatus,
+                    lastUpdated: new Date().toISOString()
+                }
+            };
+        });
+        return configuration;
+    }
+    /**
+     * Initializes installation status for a feed configuration
+     */
+    static initializeInstallationStatus(feedConfig) {
+        const requirementsStatus = {};
+        const serversStatus = {};
+        if (feedConfig) {
+            if (feedConfig.requirements) {
+                for (const req of feedConfig.requirements) {
+                    requirementsStatus[req.name] = {
+                        name: req.name,
+                        type: req.type,
+                        installed: false,
+                        version: req.version,
+                        error: undefined
+                    };
+                }
+            }
+            if (feedConfig.mcpServers) {
+                for (const mcp of feedConfig.mcpServers) {
+                    serversStatus[mcp.name] = {
+                        name: mcp.name,
+                        error: undefined,
+                        installedStatus: {}
+                    };
+                }
+            }
+        }
+        return {
+            requirementsStatus,
+            serversStatus,
+            lastUpdated: new Date().toISOString()
+        };
+    }
+    /**
+     * Synchronizes server categories with feeds
+     */
+    static async syncServerCategoriesWithFeeds(configuration) {
+        // Filter out categories that don't have corresponding feeds and update existing ones
+        configuration.localServerCategories = configuration.localServerCategories
+            .filter(server => configuration.feeds[server.name])
+            .map(server => {
+            server.feedConfiguration = configuration.feeds[server.name];
+            if (!server.installationStatus ||
+                !server.installationStatus.requirementsStatus ||
+                Object.keys(server.installationStatus.requirementsStatus).length === 0 ||
+                !server.installationStatus.serversStatus ||
+                Object.keys(server.installationStatus.serversStatus).length < Object.keys(server.feedConfiguration?.mcpServers || []).length) {
+                server.installationStatus = ConfigurationLoader.initializeInstallationStatus(server.feedConfiguration);
+            }
+            return server;
+        });
+        // Add new categories for feeds that don't have a corresponding category
+        const existingServerNames = new Set(configuration.localServerCategories.map(category => category.name));
+        for (const [feedName, feedConfig] of Object.entries(configuration.feeds)) {
+            if (!existingServerNames.has(feedName)) {
+                const newServerCategory = {
+                    name: feedName,
+                    displayName: feedConfig.displayName || feedName,
+                    type: 'local',
+                    description: feedConfig.description || `Local MCP server category: ${feedName}`,
+                    installationStatus: ConfigurationLoader.initializeInstallationStatus(feedConfig),
+                    feedConfiguration: feedConfig
+                };
+                configuration.localServerCategories.push(newServerCategory);
+                console.log(`Created new local server entry for feed: ${feedName}`);
+            }
+        }
+        return configuration;
+    }
+    /**
+     * Loads feed configurations into the MCP configuration
+     */
+    static async loadFeedsIntoConfiguration(configuration, feedFile) {
+        try {
+            await fs.mkdir(LOCAL_FEEDS_DIR, { recursive: true });
+            const feeds = {};
+            // Load provided feed file if specified
+            if (feedFile) {
+                try {
+                    const content = await fs.readFile(feedFile, 'utf8');
+                    const config = JSON.parse(content);
+                    if (config && config.name) {
+                        feeds[config.name] = config;
+                        console.log(`Loaded feed configuration from provided file: ${feedFile}`);
+                    }
+                }
+                catch (error) {
+                    console.log(`Error loading feed configuration from provided file ${feedFile}:`, error);
+                }
+            }
+            // Load feeds from LOCAL_FEEDS_DIR
+            const files = await fs.readdir(LOCAL_FEEDS_DIR);
+            const jsonFiles = files.filter(file => file.endsWith('.json'));
+            if (jsonFiles.length === 0 && !feedFile) {
+                console.log(`No feed configuration files found in ${LOCAL_FEEDS_DIR}`);
+                return configuration;
+            }
+            for (const file of jsonFiles) {
+                try {
+                    const filePath = path.join(LOCAL_FEEDS_DIR, file);
+                    const content = await fs.readFile(filePath, 'utf8');
+                    const config = JSON.parse(content);
+                    if (config && config.name) {
+                        // If feed exists from provided file, skip the local one
+                        if (!feeds[config.name]) {
+                            feeds[config.name] = config;
+                        }
+                        else {
+                            console.log(`Skipping local feed ${config.name} as it was provided via --feed-file`);
+                        }
+                    }
+                }
+                catch (error) {
+                    console.warn(`Error loading feed configuration from ${file}:`, error);
+                }
+            }
+            configuration.feeds = feeds;
+            return await ConfigurationLoader.syncServerCategoriesWithFeeds(configuration);
+        }
+        catch (error) {
+            console.error("Error loading feed configurations:", error);
+            throw error;
+        }
+    }
+    /**
+     * Loads MCP client settings into the configuration
+     */
+    static async loadClientMCPSettings(configuration) {
+        try {
+            Logger.debug('Starting to load MCP client settings...');
+            const settings = {};
+            for (const [clientName, clientSettings] of Object.entries(SUPPORTED_CLIENTS)) {
+                const settingPath = process.env.CODE_INSIDERS
+                    ? clientSettings.codeInsiderSettingPath
+                    : clientSettings.codeSettingPath;
+                try {
+                    let content = await readJsonFile(settingPath, true);
+                    if (clientName === 'GithubCopilot') {
+                        if (!content.mcp) {
+                            content = {
+                                servers: {},
+                                inputs: []
+                            };
+                        }
+                        else {
+                            content = content.mcp;
+                        }
+                    }
+                    settings[clientName] = content;
+                    Logger.debug(`Successfully loaded MCP settings for ${clientName}`);
+                }
+                catch (error) {
+                    Logger.debug(`Warning: Could not load MCP settings for client ${clientName}: ${error instanceof Error ? error.message : String(error)}`);
+                    settings[clientName] = {};
+                }
+            }
+            configuration.clientMCPSettings = settings;
+            return ConfigurationLoader.syncServerCategoriesWithClientSettings(configuration);
+        }
+        catch (error) {
+            Logger.error('Error loading client MCP settings:', error);
+            throw error;
+        }
+    }
+}
+//# sourceMappingURL=ConfigurationLoader.js.map

package/dist/core/ConfigurationProvider.d.ts

@@ -0,0 +1,35 @@
+import { MCPServerCategory, FeedConfiguration, InstallationStatus, RequirementStatus, MCPServerStatus, OperationStatus, McpConfig } from './types.js';
+export declare class ConfigurationProvider {
+    private static instance;
+    private configPath;
+    private configuration;
+    private configLock;
+    private tempDir;
+    private constructor();
+    static getInstance(): ConfigurationProvider;
+    private withLock;
+    initialize(feedFile?: string): Promise<void>;
+    private saveConfiguration;
+    getServerCategories(): Promise<MCPServerCategory[]>;
+    getServerCategory(categoryName: string): Promise<MCPServerCategory | undefined>;
+    getClientMcpSettings(): Promise<Record<string, Record<string, any>> | undefined>;
+    getFeedConfiguration(categoryName: string): Promise<FeedConfiguration | undefined>;
+    getServerMcpConfig(categoryName: string, serverName: string): Promise<McpConfig | undefined>;
+    getInstallationStatus(categoryName: string): Promise<InstallationStatus | undefined>;
+    getServerStatus(categoryName: string, serverName: string): Promise<MCPServerStatus | undefined>;
+    getRequirementStatus(categoryName: string, requirementName: string): Promise<RequirementStatus | undefined>;
+    updateInstallationStatus(categoryName: string, requirementStatus: Record<string, RequirementStatus>, serverStatus: Record<string, MCPServerStatus>): Promise<boolean>;
+    updateRequirementStatus(categoryName: string, requirementName: string, status: RequirementStatus): Promise<boolean>;
+    updateRequirementOperationStatus(categoryName: string, requirementName: string, operationStatus: OperationStatus): Promise<boolean>;
+    updateServerStatus(categoryName: string, serverName: string, status: MCPServerStatus): Promise<boolean>;
+    updateServerOperationStatus(categoryName: string, serverName: string, clientName: string, operationStatus: OperationStatus): Promise<boolean>;
+    isRequirementsReady(categoryName: string, serverName: string): Promise<boolean>;
+    GetServerRequirementStatus(categoryName: string, serverName: string): Promise<RequirementStatus[]>;
+    isServerReady(categoryName: string, serverName: string, clients: string[]): Promise<boolean>;
+    syncFeeds(): Promise<void>;
+    private loadFeedsIntoConfiguration;
+    private loadClientMCPSettings;
+    reloadClientMCPSettings(): Promise<void>;
+    removeServerFromClientMCPSettings(serverName: string, target?: string): Promise<void>;
+}
+export declare const configProvider: ConfigurationProvider;