mcp-use TypeScript API
    Preparing search index...

    Type Alias ResourceCallback<TUser, HasOAuth, TEnv>

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

    Resource read callback. Prefer the SDK's raw ReadResourceResult; each contents entry addresses itself with the read uri.

    Deprecated response helpers that return a CallToolResult are still accepted and converted at registration time.

    Type Parameters

    • TUser = never
    • HasOAuth extends boolean = false
    • TEnv extends Env = Env

    Type Declaration

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

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

    async (uri) => ({
    contents: [{ uri: uri.href, mimeType: "text/plain", text: "hello" }],
    })