mcp-use TypeScript API
    Preparing search index...

    Interface OpenAPIDocument

    Parsed, bundled OpenAPI 3.x document accepted by MCPServer.fromOpenAPI.

    External references are not fetched. Bundle them into local #/... references before constructing the server.

    interface OpenAPIDocument {
        components?: Record<string, unknown>;
        info: { title: string; version?: string };
        openapi: string;
        paths?: Record<string, OpenAPIReferenceObject | OpenAPIPathItemObject>;
        servers?: { url: string }[];
    }
    Index
    components? info openapi paths? servers?
    components?: Record<string, unknown>

    Reusable schemas, parameters, and request bodies addressed by local references.

    info: { title: string; version?: string }

    API identity used as the generated MCP server defaults.

    Type Declaration

    • title: string

      Human-readable API title, used as the default server name.

    • Optionalversion?: string

      API version, used as the default server version when present.

    openapi: string

    OpenAPI document version, for example "3.1.0".

    paths?: Record<string, OpenAPIReferenceObject | OpenAPIPathItemObject>

    API operations keyed by URL path template.

    servers?: { url: string }[]

    Candidate upstream base URLs; the first is used by default.

    Type Declaration

    • url: string

      Absolute upstream base URL.

    Settings
    Member Visibility

    On This Page
    Properties