mcp-use TypeScript API
    Preparing search index...

    Type Alias ResourceTemplateCallback<TParams, TUser, HasOAuth, TEnv>

    ResourceTemplateCallback: (
        uri: URL,
        params: TParams,
        ctx: RequestContext<TUser, HasOAuth, TEnv>,
    ) =>
        | ReadResourceResult
        | CallToolResult
        | Promise<ReadResourceResult | CallToolResult>

    Resource template read callback; receives the matched URI and variables.

    Prefer ReadResourceResult. Deprecated helper-shaped CallToolResult returns are still accepted and converted.

    Type Parameters

    • TParams = Record<string, TemplateVariableValue>
    • TUser = never
    • HasOAuth extends boolean = false
    • TEnv extends Env = Env

    Type Declaration

      • (
            uri: URL,
            params: TParams,
            ctx: RequestContext<TUser, HasOAuth, TEnv>,
        ):
            | ReadResourceResult
            | CallToolResult
            | Promise<ReadResourceResult | CallToolResult>

      • Parameters

        Returns
            | ReadResourceResult
            | CallToolResult
            | Promise<ReadResourceResult | CallToolResult>

    Settings
    Member Visibility