MCP Server Framework - v1.0.0
    Preparing search index...

    Module mcp-server-framework

    MCP Server Framework

    A production-ready framework for building Model Context Protocol servers. Provides a clean, type-safe API for defining tools, resources, and prompts.

    import { createServer, defineTool, text, z } from 'mcp-server-framework';

    const healthTool = defineTool({
    name: 'health',
    description: 'Check server health',
    input: z.object({}),
    handler: async () => text('OK'),
    });

    const { start } = createServer({
    name: 'my-server',
    version: '1.0.0',
    transport: { mode: 'stdio' },
    });

    await start();

    Internal modules are available via subpath imports for advanced use cases:

    import { ConnectionStateManager } from 'mcp-server-framework/connection';
    import { SessionManagerImpl } from 'mcp-server-framework/session';
    import { startHttpTransport, createExpressApp } from 'mcp-server-framework/http';
    import { getActiveSpan, SpanKind } from 'mcp-server-framework/telemetry';
    import { FrameworkErrorFactory } from 'mcp-server-framework/errors';
    import { Logger } from 'mcp-server-framework/logger';
    import { getFrameworkConfig } from 'mcp-server-framework/config';

    Namespaces

    z

    Classes

    AppError
    AuthenticationError
    AuthorizationError
    ConfigurationError
    ConnectionError
    ConnectionStateManager
    InternalError
    Logger
    McpProtocolError
    McpServerBuilder
    OperationCancelledError
    OperationError
    PromptRegistry
    ProxyOAuthServerProvider
    RegistryError
    ResourceRegistry
    SessionError
    TaskToolRegistry
    ToolRegistry
    TransportError
    ValidationError

    Interfaces

    AppDefinition
    AppResourceDefinition
    AudioResponseOptions
    AuthInfo
    AuthOptions
    BaseErrorOptions
    BaseHttpTransportOptions
    BaseResourceDefinition
    BearerAuthOptions
    BlobResourceContent
    CompletionResult
    ConfigConstraintViolation
    ConfigSource
    ContentAnnotations
    CreateServerOptions
    CreateServerResult
    CustomHeaderAuthOptions
    ErrorResponseOptions
    EventStore
    HandlersConfig
    HealthCheckResult
    HealthConfig
    HttpsTransportOptions
    HttpTransportOptions
    ImageResponseOptions
    JsonResponseOptions
    LoggerConfig
    LoggerInterface
    OAuthServerProvider
    OidcDiscoveryDocument
    OidcProviderOptions
    ProgressData
    PromptDefinition
    PromptMessage
    PromptProvider
    RegistryItem
    ResourceProvider
    ResourceStaticDefinition
    ResourceTemplateDefinition
    ResponseOptions
    SerializedError
    ServerBuilder
    ServerCapabilities
    ServerInstance
    ServerLifecycleHooks
    ServerMetrics
    ServerOptions
    ServerStats
    ServiceClient
    SessionConfigOptions
    ShutdownConfig
    SpanOptions
    StdioTransportOptions
    TaskCreateContext
    TaskOperationContext
    TaskToolDefinition
    TaskToolHandler
    TaskToolProvider
    TelemetryConfig
    TextResourceContent
    TextResponseOptions
    TlsConfig
    TokenVerifier
    ToolAnnotations
    ToolContext
    ToolDefinition
    ToolProvider
    UpstreamEndpoints
    UpstreamOAuthOptions
    UpstreamOAuthProviderResult
    ValidationErrorOptions
    ValidationIssue

    Type Aliases

    AudioMimeType
    AuthenticatedExtra
    AuthProvider
    CompletionCallback
    ConfigFileFormat
    ContentAudience
    CreateMessageRequest
    CreateMessageRequestParams
    CreateMessageRequestParamsBase
    CreateMessageResult
    ElicitRequestFormParams
    ElicitRequestURLParams
    ElicitResult
    ErrorCodeType
    EventId
    FrameworkEnvConfig
    FrameworkErrorFactoryType
    HealthStatus
    ImageMimeType
    ListRootsResult
    LogLevel
    PingHandler
    ProgressReporter
    PromptRole
    ProxyEndpoints
    ProxyOptions
    ResourceContent
    ResourceDefinition
    Root
    SamplingMessage
    ServerState
    ServiceClientFactory
    StreamId
    TaskSupport
    ToolResponse
    TransportMode
    TransportOptions

    Variables

    CONFIG_FILE_ENV_VAR
    DISCOVERY_FILENAMES
    frameworkEnvSchema
    FrameworkErrorFactory
    globalPromptRegistry
    globalResourceRegistry
    globalTaskToolRegistry
    globalToolRegistry
    logger
    MCP_ATTRIBUTES

    Functions

    audio
    booleanFromEnv
    clearOidcDiscoveryCache
    commaSeparatedList
    configureLogger
    createBearerAuth
    createCustomHeaderAuth
    createOidcProvider
    createServer
    createUpstreamOAuthProvider
    defineApp
    definePrompt
    defineResource
    defineResourceTemplate
    defineTask
    defineTool
    error
    fetchOidcDiscovery
    getAppConfig
    getConfigSource
    getEnvOptional
    getEnvString
    getFrameworkConfig
    getLoggerConfig
    getOidcDiscovery
    getTracer
    hasAllScopes
    hasAnyScope
    hasScope
    image
    initializeTelemetry
    isFullOAuthProvider
    isHttpTransport
    isResourceTemplate
    isServiceClient
    isStaticResource
    isTelemetryEnabled
    json
    multi
    optionalCommaSeparatedList
    parseEnvBoolean
    registerConfigSection
    requireAuth
    requireScope
    requireScopes
    resetAllRegistries
    shutdownTelemetry
    text
    validateConfigConstraints
    withSpan
    withSpanSync