Configuration Guide

import { OpenAPIServer } from "@lucid-spark/openapi-mcp-server";

const config = {
  apiBaseUrl: "https://api.example.com",
  openApiSpec: "https://api.example.com/openapi.json",
  headers: {
    Authorization: "Bearer your-token",
    "X-API-Key": "your-api-key"
  },
  transportType: "stdio" as const
};

const server = new OpenAPIServer(config);
await server.start();

import { OpenAPIServer, IAuthProvider } from "@lucid-spark/openapi-mcp-server";

class CustomAuthProvider implements IAuthProvider {
  async getAuthHeaders(): Promise> {
    // Dynamic authentication logic
    return {
      Authorization: `Bearer ${await this.getValidToken()}`,
      "X-Custom-Header": "custom-value"
    };
  }

  async handleAuthError(error: any): Promise {
    // Handle auth errors and retry logic
    if (error.response?.status === 401) {
      await this.refreshToken();
      return true; // Retry request
    }
    return false;
  }
}

const config = {
  apiBaseUrl: "https://api.example.com",
  openApiSpec: "./api-spec.yaml",
  specInputMethod: "file" as const,
  authProvider: new CustomAuthProvider(),
  transportType: "http" as const,
  httpPort: 8080,
  toolsMode: "all" as const,
  includeTags: ["users", "posts"],
  debug: true
};

const server = new OpenAPIServer(config);

import { validateConfig } from "@lucid-spark/openapi-mcp-server";

// Validate configuration before creating server
try {
  const validatedConfig = validateConfig(config);
  const server = new OpenAPIServer(validatedConfig);
} catch (error) {
  console.error("Configuration validation failed:", error.message);
}

{
  "mcpServers": {
    "openapi": {
      "command": "npx",
      "args": ["-y", "@lucid-spark/openapi-mcp-server", "openapi-mcp-server"],
      "env": {
        "API_BASE_URL": "https://api.example.com",
        "OPENAPI_SPEC_PATH": "https://api.example.com/openapi.json",
        "API_HEADERS": "Authorization:Bearer token123"
      }
    }
  }
}

{
  "mcpServers": {
    "github-api": {
      "command": "npx",
      "args": [
        "-y",
        "@lucid-spark/openapi-mcp-server",
        "openapi-mcp-server",
        "--api-base-url",
        "https://api.github.com",
        "--openapi-spec",
        "https://api.github.com/openapi.json",
        "--tag",
        "public",
        "--operation",
        "GET",
        "--operation",
        "POST"
      ],
      "env": {
        "GITHUB_TOKEN": "ghp_xxxxxxxxxxxx",
        "API_HEADERS": "Authorization:Bearer ${GITHUB_TOKEN},Accept:application/vnd.github.v3+json"
      }
    }
  }
}