@robinmordasiewicz/f5xc-api-mcp 3.0.0

package/dist/resources/templates.js

@@ -0,0 +1,248 @@
+/**
+ * MCP Resource URI Templates
+ *
+ * Defines URI templates for F5XC configuration resources.
+ * URI scheme: f5xc://{tenant}/{namespace}/{resource-type}/{name}
+ */
+/**
+ * Resource URI schemes
+ */
+export const RESOURCE_SCHEMES = {
+    /** Base scheme for all F5XC resources */
+    BASE: "f5xc://",
+    /** System namespace for global resources */
+    SYSTEM: "system",
+    /** Shared namespace for cross-tenant resources */
+    SHARED: "shared",
+};
+/**
+ * All supported resource types
+ */
+export const RESOURCE_TYPES = {
+    // Core Resources (NO_TIER)
+    namespace: {
+        type: "namespace",
+        name: "Namespace",
+        description: "Logical grouping of resources",
+        apiPath: "/api/web/namespaces",
+        namespaceScoped: false,
+        tier: "NO_TIER",
+    },
+    certificate: {
+        type: "certificate",
+        name: "Certificate",
+        description: "TLS/SSL certificate",
+        apiPath: "/api/config/namespaces/{namespace}/certificates",
+        namespaceScoped: true,
+        tier: "NO_TIER",
+    },
+    secret: {
+        type: "secret",
+        name: "Secret",
+        description: "Sensitive data storage",
+        apiPath: "/api/config/namespaces/{namespace}/secrets",
+        namespaceScoped: true,
+        tier: "NO_TIER",
+    },
+    cloud_credentials: {
+        type: "cloud_credentials",
+        name: "Cloud Credentials",
+        description: "Cloud provider authentication",
+        apiPath: "/api/config/namespaces/{namespace}/cloud_credentials",
+        namespaceScoped: true,
+        tier: "NO_TIER",
+    },
+    // Standard Resources
+    http_loadbalancer: {
+        type: "http_loadbalancer",
+        name: "HTTP Load Balancer",
+        description: "Layer 7 HTTP/HTTPS load balancer",
+        apiPath: "/api/config/namespaces/{namespace}/http_loadbalancers",
+        namespaceScoped: true,
+        tier: "STANDARD",
+        relatedResources: ["origin_pool", "healthcheck", "app_firewall"],
+    },
+    tcp_loadbalancer: {
+        type: "tcp_loadbalancer",
+        name: "TCP Load Balancer",
+        description: "Layer 4 TCP load balancer",
+        apiPath: "/api/config/namespaces/{namespace}/tcp_loadbalancers",
+        namespaceScoped: true,
+        tier: "STANDARD",
+        relatedResources: ["origin_pool", "healthcheck"],
+    },
+    origin_pool: {
+        type: "origin_pool",
+        name: "Origin Pool",
+        description: "Backend server pool for load balancing",
+        apiPath: "/api/config/namespaces/{namespace}/origin_pools",
+        namespaceScoped: true,
+        tier: "STANDARD",
+        relatedResources: ["healthcheck"],
+    },
+    healthcheck: {
+        type: "healthcheck",
+        name: "Health Check",
+        description: "Health monitoring for origin servers",
+        apiPath: "/api/config/namespaces/{namespace}/healthchecks",
+        namespaceScoped: true,
+        tier: "STANDARD",
+    },
+    dns_zone: {
+        type: "dns_zone",
+        name: "DNS Zone",
+        description: "DNS zone management",
+        apiPath: "/api/config/namespaces/{namespace}/dns_zones",
+        namespaceScoped: true,
+        tier: "STANDARD",
+    },
+    dns_load_balancer: {
+        type: "dns_load_balancer",
+        name: "DNS Load Balancer",
+        description: "Global DNS-based load balancing",
+        apiPath: "/api/config/namespaces/{namespace}/dns_load_balancers",
+        namespaceScoped: true,
+        tier: "STANDARD",
+        relatedResources: ["dns_zone"],
+    },
+    // Site Resources
+    aws_vpc_site: {
+        type: "aws_vpc_site",
+        name: "AWS VPC Site",
+        description: "F5XC site deployed in AWS VPC",
+        apiPath: "/api/config/namespaces/{namespace}/aws_vpc_sites",
+        namespaceScoped: true,
+        tier: "STANDARD",
+        relatedResources: ["cloud_credentials"],
+    },
+    azure_vnet_site: {
+        type: "azure_vnet_site",
+        name: "Azure VNet Site",
+        description: "F5XC site deployed in Azure VNet",
+        apiPath: "/api/config/namespaces/{namespace}/azure_vnet_sites",
+        namespaceScoped: true,
+        tier: "STANDARD",
+        relatedResources: ["cloud_credentials"],
+    },
+    gcp_vpc_site: {
+        type: "gcp_vpc_site",
+        name: "GCP VPC Site",
+        description: "F5XC site deployed in GCP VPC",
+        apiPath: "/api/config/namespaces/{namespace}/gcp_vpc_sites",
+        namespaceScoped: true,
+        tier: "STANDARD",
+        relatedResources: ["cloud_credentials"],
+    },
+    // Advanced Resources (WAAP)
+    app_firewall: {
+        type: "app_firewall",
+        name: "Application Firewall",
+        description: "Web Application Firewall (WAF) policy",
+        apiPath: "/api/config/namespaces/{namespace}/app_firewalls",
+        namespaceScoped: true,
+        tier: "ADVANCED",
+    },
+    service_policy: {
+        type: "service_policy",
+        name: "Service Policy",
+        description: "Service-level security policy",
+        apiPath: "/api/config/namespaces/{namespace}/service_policys",
+        namespaceScoped: true,
+        tier: "ADVANCED",
+    },
+    rate_limiter: {
+        type: "rate_limiter",
+        name: "Rate Limiter",
+        description: "Request rate limiting policy",
+        apiPath: "/api/config/namespaces/{namespace}/rate_limiters",
+        namespaceScoped: true,
+        tier: "ADVANCED",
+    },
+    bot_defense: {
+        type: "bot_defense",
+        name: "Bot Defense",
+        description: "Bot detection and mitigation",
+        apiPath: "/api/config/namespaces/{namespace}/bot_defenses",
+        namespaceScoped: true,
+        tier: "ADVANCED",
+    },
+    api_definition: {
+        type: "api_definition",
+        name: "API Definition",
+        description: "OpenAPI specification for API protection",
+        apiPath: "/api/config/namespaces/{namespace}/api_definitions",
+        namespaceScoped: true,
+        tier: "ADVANCED",
+    },
+};
+/**
+ * Build resource URI from components
+ *
+ * @param tenant - Tenant name
+ * @param namespace - Namespace (or 'system'/'shared')
+ * @param resourceType - Resource type identifier
+ * @param name - Resource name
+ * @returns Formatted resource URI
+ */
+export function buildResourceUri(tenant, namespace, resourceType, name) {
+    return `${RESOURCE_SCHEMES.BASE}${tenant}/${namespace}/${resourceType}/${name}`;
+}
+/**
+ * Parse resource URI into components
+ *
+ * @param uri - Resource URI to parse
+ * @returns Parsed components or null if invalid
+ */
+export function parseResourceUri(uri) {
+    if (!uri.startsWith(RESOURCE_SCHEMES.BASE)) {
+        return null;
+    }
+    const path = uri.slice(RESOURCE_SCHEMES.BASE.length);
+    const parts = path.split("/");
+    if (parts.length !== 4) {
+        return null;
+    }
+    const [tenant, namespace, resourceType, name] = parts;
+    if (!tenant || !namespace || !resourceType || !name) {
+        return null;
+    }
+    return { tenant, namespace, resourceType, name };
+}
+/**
+ * Get resource type definition
+ *
+ * @param type - Resource type identifier
+ * @returns Resource type definition or undefined
+ */
+export function getResourceType(type) {
+    return RESOURCE_TYPES[type];
+}
+/**
+ * Get all resource types for a tier
+ *
+ * @param tier - Subscription tier
+ * @returns Array of resource types
+ */
+export function getResourceTypesByTier(tier) {
+    return Object.values(RESOURCE_TYPES).filter((rt) => rt.tier === tier);
+}
+/**
+ * Build API path for a resource
+ *
+ * @param resourceType - Resource type identifier
+ * @param namespace - Namespace name
+ * @param name - Resource name (optional)
+ * @returns API path
+ */
+export function buildApiPath(resourceType, namespace, name) {
+    const rt = RESOURCE_TYPES[resourceType];
+    if (!rt) {
+        return null;
+    }
+    let path = rt.apiPath.replace("{namespace}", namespace);
+    if (name) {
+        path += `/${name}`;
+    }
+    return path;
+}
+//# sourceMappingURL=templates.js.map

package/dist/resources/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../src/resources/templates.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,yCAAyC;IACzC,IAAI,EAAE,SAAS;IAEf,4CAA4C;IAC5C,MAAM,EAAE,QAAQ;IAEhB,kDAAkD;IAClD,MAAM,EAAE,QAAQ;CACR,CAAC;AAsBX;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAiC;IAC1D,2BAA2B;IAC3B,SAAS,EAAE;QACT,IAAI,EAAE,WAAW;QACjB,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,+BAA+B;QAC5C,OAAO,EAAE,qBAAqB;QAC9B,eAAe,EAAE,KAAK;QACtB,IAAI,EAAE,SAAS;KAChB;IACD,WAAW,EAAE;QACX,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,qBAAqB;QAClC,OAAO,EAAE,iDAAiD;QAC1D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,SAAS;KAChB;IACD,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,wBAAwB;QACrC,OAAO,EAAE,4CAA4C;QACrD,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,SAAS;KAChB;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,mBAAmB;QACzB,WAAW,EAAE,+BAA+B;QAC5C,OAAO,EAAE,sDAAsD;QAC/D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,SAAS;KAChB;IAED,qBAAqB;IACrB,iBAAiB,EAAE;QACjB,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,oBAAoB;QAC1B,WAAW,EAAE,kCAAkC;QAC/C,OAAO,EAAE,uDAAuD;QAChE,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;QAChB,gBAAgB,EAAE,CAAC,aAAa,EAAE,aAAa,EAAE,cAAc,CAAC;KACjE;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,kBAAkB;QACxB,IAAI,EAAE,mBAAmB;QACzB,WAAW,EAAE,2BAA2B;QACxC,OAAO,EAAE,sDAAsD;QAC/D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;QAChB,gBAAgB,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC;KACjD;IACD,WAAW,EAAE;QACX,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,wCAAwC;QACrD,OAAO,EAAE,iDAAiD;QAC1D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;QAChB,gBAAgB,EAAE,CAAC,aAAa,CAAC;KAClC;IACD,WAAW,EAAE;QACX,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,sCAAsC;QACnD,OAAO,EAAE,iDAAiD;QAC1D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;KACjB;IACD,QAAQ,EAAE;QACR,IAAI,EAAE,UAAU;QAChB,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,qBAAqB;QAClC,OAAO,EAAE,8CAA8C;QACvD,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;KACjB;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,mBAAmB;QACzB,IAAI,EAAE,mBAAmB;QACzB,WAAW,EAAE,iCAAiC;QAC9C,OAAO,EAAE,uDAAuD;QAChE,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;QAChB,gBAAgB,EAAE,CAAC,UAAU,CAAC;KAC/B;IAED,iBAAiB;IACjB,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,+BAA+B;QAC5C,OAAO,EAAE,kDAAkD;QAC3D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;QAChB,gBAAgB,EAAE,CAAC,mBAAmB,CAAC;KACxC;IACD,eAAe,EAAE;QACf,IAAI,EAAE,iBAAiB;QACvB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,kCAAkC;QAC/C,OAAO,EAAE,qDAAqD;QAC9D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;QAChB,gBAAgB,EAAE,CAAC,mBAAmB,CAAC;KACxC;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,+BAA+B;QAC5C,OAAO,EAAE,kDAAkD;QAC3D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;QAChB,gBAAgB,EAAE,CAAC,mBAAmB,CAAC;KACxC;IAED,4BAA4B;IAC5B,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EAAE,uCAAuC;QACpD,OAAO,EAAE,kDAAkD;QAC3D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;KACjB;IACD,cAAc,EAAE;QACd,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,+BAA+B;QAC5C,OAAO,EAAE,oDAAoD;QAC7D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;KACjB;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,8BAA8B;QAC3C,OAAO,EAAE,kDAAkD;QAC3D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;KACjB;IACD,WAAW,EAAE;QACX,IAAI,EAAE,aAAa;QACnB,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,8BAA8B;QAC3C,OAAO,EAAE,iDAAiD;QAC1D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;KACjB;IACD,cAAc,EAAE;QACd,IAAI,EAAE,gBAAgB;QACtB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,0CAA0C;QACvD,OAAO,EAAE,oDAAoD;QAC7D,eAAe,EAAE,IAAI;QACrB,IAAI,EAAE,UAAU;KACjB;CACF,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAAc,EACd,SAAiB,EACjB,YAAoB,EACpB,IAAY;IAEZ,OAAO,GAAG,gBAAgB,CAAC,IAAI,GAAG,MAAM,IAAI,SAAS,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;AAClF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,GAAW;IAEX,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAE9B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC;IAEtD,IAAI,CAAC,MAAM,IAAI,CAAC,SAAS,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,EAAE,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY;IAC1C,OAAO,cAAc,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,IAAyC;IAC9E,OAAO,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,YAAoB,EACpB,SAAiB,EACjB,IAAa;IAEb,MAAM,EAAE,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC;IACxC,IAAI,CAAC,EAAE,EAAE,CAAC;QACR,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAExD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,IAAI,IAAI,IAAI,EAAE,CAAC;IACrB,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/server.d.ts

@@ -0,0 +1,78 @@
+/**
+ * F5 Distributed Cloud API MCP Server
+ *
+ * This module initializes and configures the MCP server with STDIO transport.
+ * Supports dual-mode operation: documentation mode (unauthenticated) and
+ * execution mode (authenticated with F5XC credentials).
+ */
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { CredentialManager } from "./auth/credential-manager.js";
+/**
+ * Server configuration options
+ */
+export interface ServerConfig {
+    /** Server name for MCP identification */
+    name: string;
+    /** Server version */
+    version: string;
+    /** Credential manager for auth handling */
+    credentialManager: CredentialManager;
+}
+/**
+ * F5XC API MCP Server
+ *
+ * Provides tools, resources, and prompts for interacting with F5 Distributed Cloud APIs.
+ * Works in two modes:
+ * - Documentation mode: Returns API documentation, schemas, f5xcctl equivalents, Terraform examples
+ * - Execution mode: Directly executes API calls when authenticated
+ */
+export declare class F5XCApiServer {
+    private server;
+    private credentialManager;
+    private httpClient;
+    private resourceHandler;
+    private transport;
+    constructor(config: ServerConfig);
+    /**
+     * Register all MCP capabilities (tools, resources, prompts)
+     */
+    private registerCapabilities;
+    /**
+     * Register MCP tools for F5XC API operations
+     *
+     * Uses the dynamic discovery pattern for token efficiency:
+     * - 3 meta-tools instead of 1,400+ individual tools
+     * - Reduces upfront token consumption from ~535K to ~500 tokens
+     * - Full tool schemas loaded on-demand via describe_tool
+     */
+    private registerTools;
+    /**
+     * Register MCP resources for F5XC configuration objects
+     */
+    private registerResources;
+    /**
+     * Register MCP prompts for common workflows
+     */
+    private registerPrompts;
+    /**
+     * Start the MCP server with STDIO transport
+     */
+    start(): Promise<void>;
+    /**
+     * Stop the MCP server
+     */
+    stop(): Promise<void>;
+    /**
+     * Get the underlying MCP server instance
+     */
+    getMcpServer(): McpServer;
+    /**
+     * Get the credential manager
+     */
+    getCredentialManager(): CredentialManager;
+}
+/**
+ * Create and configure the F5XC API MCP Server
+ */
+export declare function createServer(): F5XCApiServer;
+//# sourceMappingURL=server.d.ts.map

package/dist/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAGpE,OAAO,EAAE,iBAAiB,EAAY,MAAM,8BAA8B,CAAC;AAoB3E;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,iBAAiB,EAAE,iBAAiB,CAAC;CACtC;AAED;;;;;;;GAOG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,MAAM,CAAY;IAC1B,OAAO,CAAC,iBAAiB,CAAoB;IAC7C,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,SAAS,CAAqC;gBAE1C,MAAM,EAAE,YAAY;IAmBhC;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAM5B;;;;;;;OAOG;IACH,OAAO,CAAC,aAAa;IAgUrB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAmCzB;;OAEG;IACH,OAAO,CAAC,eAAe;IAmDvB;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAa5B;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3B;;OAEG;IACH,YAAY,IAAI,SAAS;IAIzB;;OAEG;IACH,oBAAoB,IAAI,iBAAiB;CAG1C;AAED;;GAEG;AACH,wBAAgB,YAAY,IAAI,aAAa,CAQ5C"}