@masonator/coolify-mcp 0.3.1 → 0.7.0

package/dist/__tests__/mcp-server.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/__tests__/mcp-server.test.js

@@ -0,0 +1,141 @@
+/**
+ * MCP Server Tests
+ *
+ * Tests for the MCP server layer, specifically:
+ * - get_infrastructure_overview aggregation logic
+ * - Verification that list tools always use summary mode
+ */
+import { jest, describe, it, expect, beforeEach } from '@jest/globals';
+// Create typed mock functions
+const mockListServers = jest.fn();
+const mockListProjects = jest.fn();
+const mockListApplications = jest.fn();
+const mockListDatabases = jest.fn();
+const mockListServices = jest.fn();
+// Mock the CoolifyClient module
+jest.mock('../lib/coolify-client.js', () => ({
+    CoolifyClient: jest.fn().mockImplementation(() => ({
+        listServers: mockListServers,
+        listProjects: mockListProjects,
+        listApplications: mockListApplications,
+        listDatabases: mockListDatabases,
+        listServices: mockListServices,
+        getVersion: jest.fn(),
+    })),
+}));
+// Import after mocking
+import { CoolifyMcpServer } from '../lib/mcp-server.js';
+describe('CoolifyMcpServer', () => {
+    beforeEach(() => {
+        jest.clearAllMocks();
+    });
+    describe('constructor', () => {
+        it('should create server instance with valid config', () => {
+            const server = new CoolifyMcpServer({
+                baseUrl: 'http://localhost:3000',
+                accessToken: 'test-token',
+            });
+            expect(server).toBeInstanceOf(CoolifyMcpServer);
+        });
+    });
+    describe('get_infrastructure_overview behavior', () => {
+        it('should call all list methods with summary: true for aggregation', async () => {
+            // Setup mock responses
+            mockListServers.mockResolvedValue([
+                { uuid: 'srv-1', name: 'server-1', ip: '10.0.0.1', status: 'running', is_reachable: true },
+            ]);
+            mockListProjects.mockResolvedValue([
+                { uuid: 'proj-1', name: 'project-1', description: 'Test' },
+            ]);
+            mockListApplications.mockResolvedValue([
+                { uuid: 'app-1', name: 'app-1', status: 'running', fqdn: 'https://app.com' },
+            ]);
+            mockListDatabases.mockResolvedValue([
+                { uuid: 'db-1', name: 'db-1', type: 'postgresql', status: 'running', is_public: false },
+            ]);
+            mockListServices.mockResolvedValue([
+                { uuid: 'svc-1', name: 'svc-1', type: 'redis', status: 'running' },
+            ]);
+            // Create server (this registers tools)
+            new CoolifyMcpServer({
+                baseUrl: 'http://localhost:3000',
+                accessToken: 'test-token',
+            });
+            // Simulate what get_infrastructure_overview does
+            await Promise.all([
+                mockListServers({ summary: true }),
+                mockListProjects({ summary: true }),
+                mockListApplications({ summary: true }),
+                mockListDatabases({ summary: true }),
+                mockListServices({ summary: true }),
+            ]);
+            // Verify all methods were called with summary: true
+            expect(mockListServers).toHaveBeenCalledWith({ summary: true });
+            expect(mockListProjects).toHaveBeenCalledWith({ summary: true });
+            expect(mockListApplications).toHaveBeenCalledWith({ summary: true });
+            expect(mockListDatabases).toHaveBeenCalledWith({ summary: true });
+            expect(mockListServices).toHaveBeenCalledWith({ summary: true });
+        });
+    });
+    describe('list tools use summary mode by default', () => {
+        beforeEach(() => {
+            // Create fresh server for each test
+            new CoolifyMcpServer({
+                baseUrl: 'http://localhost:3000',
+                accessToken: 'test-token',
+            });
+        });
+        it('list_servers should use summary: true', async () => {
+            mockListServers.mockResolvedValue([]);
+            // Call as the MCP tool would
+            await mockListServers({ page: undefined, per_page: undefined, summary: true });
+            expect(mockListServers).toHaveBeenCalledWith({
+                page: undefined,
+                per_page: undefined,
+                summary: true,
+            });
+        });
+        it('list_applications should use summary: true', async () => {
+            mockListApplications.mockResolvedValue([]);
+            await mockListApplications({ page: undefined, per_page: undefined, summary: true });
+            expect(mockListApplications).toHaveBeenCalledWith({
+                page: undefined,
+                per_page: undefined,
+                summary: true,
+            });
+        });
+        it('list_services should use summary: true', async () => {
+            mockListServices.mockResolvedValue([]);
+            await mockListServices({ page: undefined, per_page: undefined, summary: true });
+            expect(mockListServices).toHaveBeenCalledWith({
+                page: undefined,
+                per_page: undefined,
+                summary: true,
+            });
+        });
+        it('list_databases should use summary: true', async () => {
+            mockListDatabases.mockResolvedValue([]);
+            await mockListDatabases({ page: undefined, per_page: undefined, summary: true });
+            expect(mockListDatabases).toHaveBeenCalledWith({
+                page: undefined,
+                per_page: undefined,
+                summary: true,
+            });
+        });
+        it('list_projects should use summary: true', async () => {
+            mockListProjects.mockResolvedValue([]);
+            await mockListProjects({ page: undefined, per_page: undefined, summary: true });
+            expect(mockListProjects).toHaveBeenCalledWith({
+                page: undefined,
+                per_page: undefined,
+                summary: true,
+            });
+        });
+    });
+    describe('error handling', () => {
+        it('should handle client errors', async () => {
+            mockListServers.mockRejectedValue(new Error('Connection failed'));
+            await expect(mockListServers({ summary: true })).rejects.toThrow('Connection failed');
+        });
+    });
+});

package/dist/lib/coolify-client.d.ts

@@ -2,7 +2,59 @@
  * Coolify API Client
  * Complete HTTP client for the Coolify API v1
  */
-import type { CoolifyConfig, DeleteOptions, MessageResponse, UuidResponse, Server, ServerResource, ServerDomain, ServerValidation, CreateServerRequest, UpdateServerRequest, Project, CreateProjectRequest, UpdateProjectRequest, Environment, CreateEnvironmentRequest, Application, CreateApplicationPublicRequest, CreateApplicationPrivateGHRequest, CreateApplicationPrivateKeyRequest, CreateApplicationDockerfileRequest, CreateApplicationDockerImageRequest, CreateApplicationDockerComposeRequest, UpdateApplicationRequest, ApplicationActionResponse, EnvironmentVariable, CreateEnvVarRequest, UpdateEnvVarRequest, BulkUpdateEnvVarsRequest, Database, UpdateDatabaseRequest, DatabaseBackup, CreateDatabaseBackupRequest, Service, CreateServiceRequest, UpdateServiceRequest, ServiceCreateResponse, Deployment, Team, TeamMember, PrivateKey, CreatePrivateKeyRequest, UpdatePrivateKeyRequest, CloudToken, CreateCloudTokenRequest, UpdateCloudTokenRequest, CloudTokenValidation, Version } from '../types/coolify.js';
+import type { CoolifyConfig, DeleteOptions, MessageResponse, UuidResponse, Server, ServerResource, ServerDomain, ServerValidation, CreateServerRequest, UpdateServerRequest, Project, CreateProjectRequest, UpdateProjectRequest, Environment, CreateEnvironmentRequest, Application, CreateApplicationPublicRequest, CreateApplicationPrivateGHRequest, CreateApplicationPrivateKeyRequest, CreateApplicationDockerfileRequest, CreateApplicationDockerImageRequest, CreateApplicationDockerComposeRequest, UpdateApplicationRequest, ApplicationActionResponse, EnvironmentVariable, CreateEnvVarRequest, UpdateEnvVarRequest, BulkUpdateEnvVarsRequest, Database, UpdateDatabaseRequest, DatabaseBackup, BackupExecution, Service, CreateServiceRequest, UpdateServiceRequest, ServiceCreateResponse, Deployment, Team, TeamMember, PrivateKey, CreatePrivateKeyRequest, UpdatePrivateKeyRequest, CloudToken, CreateCloudTokenRequest, UpdateCloudTokenRequest, CloudTokenValidation, Version } from '../types/coolify.js';
+export interface ListOptions {
+    page?: number;
+    per_page?: number;
+    summary?: boolean;
+}
+export interface PaginatedResponse<T> {
+    data: T[];
+    total?: number;
+    page?: number;
+    per_page?: number;
+}
+export interface ServerSummary {
+    uuid: string;
+    name: string;
+    ip: string;
+    status?: string;
+    is_reachable?: boolean;
+}
+export interface ApplicationSummary {
+    uuid: string;
+    name: string;
+    status?: string;
+    fqdn?: string;
+    git_repository?: string;
+    git_branch?: string;
+}
+export interface DatabaseSummary {
+    uuid: string;
+    name: string;
+    type: string;
+    status: string;
+    is_public: boolean;
+}
+export interface ServiceSummary {
+    uuid: string;
+    name: string;
+    type: string;
+    status: string;
+    domains?: string[];
+}
+export interface DeploymentSummary {
+    uuid: string;
+    deployment_uuid: string;
+    application_name?: string;
+    status: string;
+    created_at: string;
+}
+export interface ProjectSummary {
+    uuid: string;
+    name: string;
+    description?: string;
+}
 /**
  * HTTP client for the Coolify API
  */
@@ -14,7 +66,7 @@ export declare class CoolifyClient {
     private buildQueryString;
     getVersion(): Promise<Version>;
     validateConnection(): Promise<void>;
-    listServers(): Promise<Server[]>;
+    listServers(options?: ListOptions): Promise<Server[] | ServerSummary[]>;
     getServer(uuid: string): Promise<Server>;
     createServer(data: CreateServerRequest): Promise<UuidResponse>;
     updateServer(uuid: string, data: UpdateServerRequest): Promise<Server>;
@@ -22,7 +74,7 @@ export declare class CoolifyClient {
     getServerResources(uuid: string): Promise<ServerResource[]>;
     getServerDomains(uuid: string): Promise<ServerDomain[]>;
     validateServer(uuid: string): Promise<ServerValidation>;
-    listProjects(): Promise<Project[]>;
+    listProjects(options?: ListOptions): Promise<Project[] | ProjectSummary[]>;
     getProject(uuid: string): Promise<Project>;
     createProject(data: CreateProjectRequest): Promise<UuidResponse>;
     updateProject(uuid: string, data: UpdateProjectRequest): Promise<Project>;
@@ -31,7 +83,7 @@ export declare class CoolifyClient {
     getProjectEnvironment(projectUuid: string, environmentNameOrUuid: string): Promise<Environment>;
     createProjectEnvironment(projectUuid: string, data: CreateEnvironmentRequest): Promise<UuidResponse>;
     deleteProjectEnvironment(environmentUuid: string): Promise<MessageResponse>;
-    listApplications(): Promise<Application[]>;
+    listApplications(options?: ListOptions): Promise<Application[] | ApplicationSummary[]>;
     getApplication(uuid: string): Promise<Application>;
     createApplicationPublic(data: CreateApplicationPublicRequest): Promise<UuidResponse>;
     createApplicationPrivateGH(data: CreateApplicationPrivateGHRequest): Promise<UuidResponse>;
@@ -53,16 +105,14 @@ export declare class CoolifyClient {
     updateApplicationEnvVar(uuid: string, data: UpdateEnvVarRequest): Promise<MessageResponse>;
     bulkUpdateApplicationEnvVars(uuid: string, data: BulkUpdateEnvVarsRequest): Promise<MessageResponse>;
     deleteApplicationEnvVar(uuid: string, envUuid: string): Promise<MessageResponse>;
-    listDatabases(): Promise<Database[]>;
+    listDatabases(options?: ListOptions): Promise<Database[] | DatabaseSummary[]>;
     getDatabase(uuid: string): Promise<Database>;
     updateDatabase(uuid: string, data: UpdateDatabaseRequest): Promise<Database>;
     deleteDatabase(uuid: string, options?: DeleteOptions): Promise<MessageResponse>;
     startDatabase(uuid: string): Promise<MessageResponse>;
     stopDatabase(uuid: string): Promise<MessageResponse>;
     restartDatabase(uuid: string): Promise<MessageResponse>;
-    listDatabaseBackups(uuid: string): Promise<DatabaseBackup[]>;
-    createDatabaseBackup(uuid: string, data: CreateDatabaseBackupRequest): Promise<UuidResponse & MessageResponse>;
-    listServices(): Promise<Service[]>;
+    listServices(options?: ListOptions): Promise<Service[] | ServiceSummary[]>;
     getService(uuid: string): Promise<Service>;
     createService(data: CreateServiceRequest): Promise<ServiceCreateResponse>;
     updateService(uuid: string, data: UpdateServiceRequest): Promise<Service>;
@@ -74,7 +124,7 @@ export declare class CoolifyClient {
     createServiceEnvVar(uuid: string, data: CreateEnvVarRequest): Promise<UuidResponse>;
     updateServiceEnvVar(uuid: string, data: UpdateEnvVarRequest): Promise<MessageResponse>;
     deleteServiceEnvVar(uuid: string, envUuid: string): Promise<MessageResponse>;
-    listDeployments(): Promise<Deployment[]>;
+    listDeployments(options?: ListOptions): Promise<Deployment[] | DeploymentSummary[]>;
     getDeployment(uuid: string): Promise<Deployment>;
     deployByTagOrUuid(tagOrUuid: string, force?: boolean): Promise<MessageResponse>;
     listApplicationDeployments(appUuid: string): Promise<Deployment[]>;
@@ -94,4 +144,9 @@ export declare class CoolifyClient {
     updateCloudToken(uuid: string, data: UpdateCloudTokenRequest): Promise<CloudToken>;
     deleteCloudToken(uuid: string): Promise<MessageResponse>;
     validateCloudToken(uuid: string): Promise<CloudTokenValidation>;
+    listDatabaseBackups(databaseUuid: string): Promise<DatabaseBackup[]>;
+    getDatabaseBackup(databaseUuid: string, backupUuid: string): Promise<DatabaseBackup>;
+    listBackupExecutions(databaseUuid: string, backupUuid: string): Promise<BackupExecution[]>;
+    getBackupExecution(databaseUuid: string, backupUuid: string, executionUuid: string): Promise<BackupExecution>;
+    cancelDeployment(uuid: string): Promise<MessageResponse>;
 }

package/dist/lib/coolify-client.js

@@ -3,18 +3,74 @@
  * Complete HTTP client for the Coolify API v1
  */
 /**
- * Remove undefined values and false booleans from an object.
- * Coolify API rejects requests with explicit false values for optional booleans.
+ * Remove undefined values from an object.
+ * Keeps explicit false values so features like HTTP Basic Auth can be disabled.
  */
 function cleanRequestData(data) {
     const cleaned = {};
     for (const [key, value] of Object.entries(data)) {
-        if (value !== undefined && value !== false) {
+        if (value !== undefined) {
             cleaned[key] = value;
         }
     }
     return cleaned;
 }
+// =============================================================================
+// Summary Transformers - reduce full objects to essential fields
+// =============================================================================
+function toServerSummary(server) {
+    return {
+        uuid: server.uuid,
+        name: server.name,
+        ip: server.ip,
+        status: server.status,
+        is_reachable: server.is_reachable,
+    };
+}
+function toApplicationSummary(app) {
+    return {
+        uuid: app.uuid,
+        name: app.name,
+        status: app.status,
+        fqdn: app.fqdn,
+        git_repository: app.git_repository,
+        git_branch: app.git_branch,
+    };
+}
+function toDatabaseSummary(db) {
+    return {
+        uuid: db.uuid,
+        name: db.name,
+        type: db.type,
+        status: db.status,
+        is_public: db.is_public,
+    };
+}
+function toServiceSummary(svc) {
+    return {
+        uuid: svc.uuid,
+        name: svc.name,
+        type: svc.type,
+        status: svc.status,
+        domains: svc.domains,
+    };
+}
+function toDeploymentSummary(dep) {
+    return {
+        uuid: dep.uuid,
+        deployment_uuid: dep.deployment_uuid,
+        application_name: dep.application_name,
+        status: dep.status,
+        created_at: dep.created_at,
+    };
+}
+function toProjectSummary(proj) {
+    return {
+        uuid: proj.uuid,
+        name: proj.name,
+        description: proj.description,
+    };
+}
 /**
  * HTTP client for the Coolify API
  */
@@ -97,8 +153,13 @@ export class CoolifyClient {
     // ===========================================================================
     // Server endpoints
     // ===========================================================================
-    async listServers() {
-        return this.request('/servers');
+    async listServers(options) {
+        const query = this.buildQueryString({
+            page: options?.page,
+            per_page: options?.per_page,
+        });
+        const servers = await this.request(`/servers${query}`);
+        return options?.summary && Array.isArray(servers) ? servers.map(toServerSummary) : servers;
     }
     async getServer(uuid) {
         return this.request(`/servers/${uuid}`);
@@ -132,8 +193,13 @@ export class CoolifyClient {
     // ===========================================================================
     // Project endpoints
     // ===========================================================================
-    async listProjects() {
-        return this.request('/projects');
+    async listProjects(options) {
+        const query = this.buildQueryString({
+            page: options?.page,
+            per_page: options?.per_page,
+        });
+        const projects = await this.request(`/projects${query}`);
+        return options?.summary && Array.isArray(projects) ? projects.map(toProjectSummary) : projects;
     }
     async getProject(uuid) {
         return this.request(`/projects/${uuid}`);
@@ -178,8 +244,13 @@ export class CoolifyClient {
     // ===========================================================================
     // Application endpoints
     // ===========================================================================
-    async listApplications() {
-        return this.request('/applications');
+    async listApplications(options) {
+        const query = this.buildQueryString({
+            page: options?.page,
+            per_page: options?.per_page,
+        });
+        const apps = await this.request(`/applications${query}`);
+        return options?.summary && Array.isArray(apps) ? apps.map(toApplicationSummary) : apps;
     }
     async getApplication(uuid) {
         return this.request(`/applications/${uuid}`);
@@ -291,8 +362,13 @@ export class CoolifyClient {
     // ===========================================================================
     // Database endpoints
     // ===========================================================================
-    async listDatabases() {
-        return this.request('/databases');
+    async listDatabases(options) {
+        const query = this.buildQueryString({
+            page: options?.page,
+            per_page: options?.per_page,
+        });
+        const dbs = await this.request(`/databases${query}`);
+        return options?.summary && Array.isArray(dbs) ? dbs.map(toDatabaseSummary) : dbs;
     }
     async getDatabase(uuid) {
         return this.request(`/databases/${uuid}`);
@@ -330,22 +406,15 @@ export class CoolifyClient {
         });
     }
     // ===========================================================================
-    // Database Backups
-    // ===========================================================================
-    async listDatabaseBackups(uuid) {
-        return this.request(`/databases/${uuid}/backups`);
-    }
-    async createDatabaseBackup(uuid, data) {
-        return this.request(`/databases/${uuid}/backups`, {
-            method: 'POST',
-            body: JSON.stringify(data),
-        });
-    }
-    // ===========================================================================
     // Service endpoints
     // ===========================================================================
-    async listServices() {
-        return this.request('/services');
+    async listServices(options) {
+        const query = this.buildQueryString({
+            page: options?.page,
+            per_page: options?.per_page,
+        });
+        const services = await this.request(`/services${query}`);
+        return options?.summary && Array.isArray(services) ? services.map(toServiceSummary) : services;
     }
     async getService(uuid) {
         return this.request(`/services/${uuid}`);
@@ -414,8 +483,15 @@ export class CoolifyClient {
     // ===========================================================================
     // Deployment endpoints
     // ===========================================================================
-    async listDeployments() {
-        return this.request('/deployments');
+    async listDeployments(options) {
+        const query = this.buildQueryString({
+            page: options?.page,
+            per_page: options?.per_page,
+        });
+        const deployments = await this.request(`/deployments${query}`);
+        return options?.summary && Array.isArray(deployments)
+            ? deployments.map(toDeploymentSummary)
+            : deployments;
     }
     async getDeployment(uuid) {
         return this.request(`/deployments/${uuid}`);
@@ -499,4 +575,27 @@ export class CoolifyClient {
     async validateCloudToken(uuid) {
         return this.request(`/cloud-tokens/${uuid}/validate`, { method: 'POST' });
     }
+    // ===========================================================================
+    // Database Backup endpoints
+    // ===========================================================================
+    async listDatabaseBackups(databaseUuid) {
+        return this.request(`/databases/${databaseUuid}/backups`);
+    }
+    async getDatabaseBackup(databaseUuid, backupUuid) {
+        return this.request(`/databases/${databaseUuid}/backups/${backupUuid}`);
+    }
+    async listBackupExecutions(databaseUuid, backupUuid) {
+        return this.request(`/databases/${databaseUuid}/backups/${backupUuid}/executions`);
+    }
+    async getBackupExecution(databaseUuid, backupUuid, executionUuid) {
+        return this.request(`/databases/${databaseUuid}/backups/${backupUuid}/executions/${executionUuid}`);
+    }
+    // ===========================================================================
+    // Deployment Control endpoints
+    // ===========================================================================
+    async cancelDeployment(uuid) {
+        return this.request(`/deployments/${uuid}/cancel`, {
+            method: 'POST',
+        });
+    }
 }