modelcontextprotocol/typescript-sdk
Watch
1
0
Fork
You've already forked typescript-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Add code reference links and backticks to JSDoc comments (#1484)

Browse source 
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Felix Weinberger <3823880+felixweinberger@users.noreply.github.com>
This commit is contained in:
Jonathan Hefner 2026-02-11 16:40:32 -06:00 • committed by GitHub
commit 42b335953a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 400 additions and 400 deletions
Download patch file Download diff file Expand all files Collapse all files

66
packages/client/src/client/auth.ts
View file

@ -44,8 +44,8 @@ export type AddClientAuthentication = (
export interface OAuthClientProvider {
/**
* The URL to redirect the user agent to after authorization.
* Return undefined for non-interactive flows that don't require user interaction
* (e.g., client_credentials, jwt-bearer).
* Return `undefined` for non-interactive flows that don't require user interaction
* (e.g., `client_credentials`, `jwt-bearer`).
*/
get redirectUrl(): string | URL | undefined;
@ -74,7 +74,7 @@ export interface OAuthClientProvider {
/**
* If implemented, this permits the OAuth client to dynamically register with
* the server. Client information saved this way should later be read via
* `clientInformation()`.
* {@linkcode OAuthClientProvider.clientInformation | clientInformation()}.
*
* This method is not required to be implemented if client information is
* statically known (e.g., pre-registered).
@ -154,11 +154,11 @@ export interface OAuthClientProvider {
* any grant-specific parameters needed for the token exchange.
*
* If not implemented, the default behavior depends on the flow:
* - For authorization code flow: uses code, code_verifier, and redirect_uri
* - For client_credentials: detected via grant_types in clientMetadata
* - For authorization code flow: uses `code`, `code_verifier`, and `redirect_uri`
* - For `client_credentials`: detected via `grant_types` in {@linkcode OAuthClientProvider.clientMetadata | clientMetadata}
*
* @param scope - Optional scope to request
* @returns Grant type and parameters, or undefined to use default behavior
* @returns Grant type and parameters, or `undefined` to use default behavior
*
* @example
* // For client_credentials grant:
@ -206,9 +206,9 @@ const AUTHORIZATION_CODE_CHALLENGE_METHOD = 'S256';
* Determines the best client authentication method to use based on server support and client configuration.
*
* Priority order (highest to lowest):
* 1. client_secret_basic (if client secret is available)
* 2. client_secret_post (if client secret is available)
* 3. none (for public clients)
* 1. `client_secret_basic` (if client secret is available)
* 2. `client_secret_post` (if client secret is available)
* 3. `none` (for public clients)
*
* @param clientInformation - OAuth client information containing credentials
* @param supportedMethods - Authentication methods supported by the authorization server
@ -253,9 +253,9 @@ export function selectClientAuthMethod(clientInformation: OAuthClientInformation
* Applies client authentication to the request based on the specified method.
*
* Implements OAuth 2.1 client authentication methods:
* - client_secret_basic: HTTP Basic authentication (RFC 6749 Section 2.3.1)
* - client_secret_post: Credentials in request body (RFC 6749 Section 2.3.1)
* - none: Public client authentication (RFC 6749 Section 2.1)
* - `client_secret_basic`: HTTP Basic authentication (RFC 6749 Section 2.3.1)
* - `client_secret_post`: Credentials in request body (RFC 6749 Section 2.3.1)
* - `none`: Public client authentication (RFC 6749 Section 2.1)
*
* @param method - The authentication method to use
* @param clientInformation - OAuth client information containing credentials
@ -323,12 +323,12 @@ function applyPublicAuth(clientId: string, params: URLSearchParams): void {
* Parses an OAuth error response from a string or Response object.
*
* If the input is a standard OAuth2.0 error response, it will be parsed according to the spec
* and an OAuthError will be returned with the appropriate error code.
* If parsing fails, it falls back to a generic ServerError that includes
* and an {@linkcode OAuthError} will be returned with the appropriate error code.
* If parsing fails, it falls back to a generic {@linkcode OAuthErrorCode.ServerError | ServerError} that includes
* the response status (if available) and original content.
*
* @param input - A Response object or string containing the error response
* @returns A Promise that resolves to an OAuthError instance
* @returns A Promise that resolves to an {@linkcode OAuthError} instance
*/
export async function parseErrorResponse(input: Response | string): Promise<OAuthError> {
const statusCode = input instanceof Response ? input.status : undefined;
@ -526,7 +526,7 @@ async function authInternal(
/**
* SEP-991: URL-based Client IDs
* Validate that the client_id is a valid URL with https scheme
* Validate that the `client_id` is a valid URL with `https` scheme
*/
export function isHttpsUrl(value?: string): boolean {
if (!value) return false;
@ -564,7 +564,7 @@ export async function selectResourceURL(
}
/**
* Extract resource_metadata, scope, and error from WWW-Authenticate header.
* Extract `resource_metadata`, `scope`, and `error` from `WWW-Authenticate` header.
*/
export function extractWWWAuthenticateParams(res: Response): { resourceMetadataUrl?: URL; scope?: string; error?: string } {
const authenticateHeader = res.headers.get('WWW-Authenticate');
@ -599,10 +599,10 @@ export function extractWWWAuthenticateParams(res: Response): { resourceMetadataU
}
/**
* Extracts a specific field's value from the WWW-Authenticate header string.
* Extracts a specific field's value from the `WWW-Authenticate` header string.
*
* @param response The HTTP response object containing the headers.
* @param fieldName The name of the field to extract (e.g., "realm", "nonce").
* @param fieldName The name of the field to extract (e.g., `"realm"`, `"nonce"`).
* @returns The field value
*/
function extractFieldFromWwwAuth(response: Response, fieldName: string): string | null {
@ -626,8 +626,8 @@ function extractFieldFromWwwAuth(response: Response, fieldName: string): string
}
/**
* Extract resource_metadata from response header.
* @deprecated Use `extractWWWAuthenticateParams` instead.
* Extract `resource_metadata` from response header.
* @deprecated Use {@linkcode extractWWWAuthenticateParams} instead.
*/
export function extractResourceMetadataUrl(res: Response): URL | undefined {
const authenticateHeader = res.headers.get('WWW-Authenticate');
@ -770,7 +770,7 @@ async function discoverMetadataWithFallback(
* If the server returns a 404 for the well-known endpoint, this function will
* return `undefined`. Any other errors will be thrown as exceptions.
*
* @deprecated This function is deprecated in favor of `discoverAuthorizationServerMetadata`.
* @deprecated This function is deprecated in favor of {@linkcode discoverAuthorizationServerMetadata}.
*/
export async function discoverOAuthMetadata(
issuer: string | URL,
@ -888,7 +888,7 @@ export function buildDiscoveryUrls(authorizationServerUrl: string | URL): { url:
* metadata was not found.
* @param options - Configuration options
* @param options.fetchFn - Optional fetch function for making HTTP requests, defaults to global fetch
* @param options.protocolVersion - MCP protocol version to use, defaults to LATEST_PROTOCOL_VERSION
* @param options.protocolVersion - MCP protocol version to use, defaults to {@linkcode LATEST_PROTOCOL_VERSION}
* @returns Promise resolving to authorization server metadata, or undefined if discovery fails
*/
export async function discoverAuthorizationServerMetadata(
@ -1016,13 +1016,13 @@ export async function startAuthorization(
/**
* Prepares token request parameters for an authorization code exchange.
*
* This is the default implementation used by fetchToken when the provider
* doesn't implement prepareTokenRequest.
* This is the default implementation used by {@linkcode fetchToken} when the provider
* doesn't implement {@linkcode OAuthClientProvider.prepareTokenRequest | prepareTokenRequest}.
*
* @param authorizationCode - The authorization code received from the authorization endpoint
* @param codeVerifier - The PKCE code verifier
* @param redirectUri - The redirect URI used in the authorization request
* @returns URLSearchParams for the authorization_code grant
* @returns URLSearchParams for the `authorization_code` grant
*/
export function prepareAuthorizationCodeRequest(
authorizationCode: string,
@ -1039,7 +1039,7 @@ export function prepareAuthorizationCodeRequest(
/**
* Internal helper to execute a token request with the given parameters.
* Used by exchangeAuthorization, refreshAuthorization, and fetchToken.
* Used by {@linkcode exchangeAuthorization}, {@linkcode refreshAuthorization}, and {@linkcode fetchToken}.
*/
async function executeTokenRequest(
authorizationServerUrl: string | URL,
@ -1157,7 +1157,7 @@ export async function exchangeAuthorization(
*
* @param authorizationServerUrl - The authorization server's base URL
* @param options - Configuration object containing client info, refresh token, etc.
* @returns Promise resolving to OAuth tokens (preserves original refresh_token if not replaced)
* @returns Promise resolving to OAuth tokens (preserves original `refresh_token` if not replaced)
* @throws {Error} When token refresh fails or authentication is invalid
*/
export async function refreshAuthorization(
@ -1197,17 +1197,17 @@ export async function refreshAuthorization(
}
/**
* Unified token fetching that works with any grant type via provider.prepareTokenRequest().
* Unified token fetching that works with any grant type via {@linkcode OAuthClientProvider.prepareTokenRequest | prepareTokenRequest()}.
*
* This function provides a single entry point for obtaining tokens regardless of the
* OAuth grant type. The provider's prepareTokenRequest() method determines which grant
* OAuth grant type. The provider's `prepareTokenRequest()` method determines which grant
* to use and supplies the grant-specific parameters.
*
* @param provider - OAuth client provider that implements prepareTokenRequest()
* @param provider - OAuth client provider that implements `prepareTokenRequest()`
* @param authorizationServerUrl - The authorization server's base URL
* @param options - Configuration for the token request
* @returns Promise resolving to OAuth tokens
* @throws {Error} When provider doesn't implement prepareTokenRequest or token fetch fails
* @throws {Error} When provider doesn't implement `prepareTokenRequest` or token fetch fails
*
* @example
* ```typescript
@ -1235,7 +1235,7 @@ export async function fetchToken(
}: {
metadata?: AuthorizationServerMetadata;
resource?: URL;
/** Authorization code for the default authorization_code grant flow */
/** Authorization code for the default `authorization_code` grant flow */
authorizationCode?: string;
fetchFn?: FetchLike;
} = {}

30
packages/client/src/client/authExtensions.ts
View file

@ -1,7 +1,7 @@
/**
* OAuth provider extensions for specialized authentication flows.
*
* This module provides ready-to-use OAuthClientProvider implementations
* This module provides ready-to-use {@linkcode OAuthClientProvider} implementations
* for common machine-to-machine authentication scenarios.
*/
@ -11,7 +11,7 @@ import type { CryptoKey, JWK } from 'jose';
import type { AddClientAuthentication, OAuthClientProvider } from './auth.js';
/**
* Helper to produce a private_key_jwt client authentication function.
* Helper to produce a `private_key_jwt` client authentication function.
*
* @example
* ```typescript
@ -90,16 +90,16 @@ export function createPrivateKeyJwtAuth(options: {
}
/**
* Options for creating a ClientCredentialsProvider.
* Options for creating a {@linkcode ClientCredentialsProvider}.
*/
export interface ClientCredentialsProviderOptions {
/**
* The client_id for this OAuth client.
* The `client_id` for this OAuth client.
*/
clientId: string;
/**
* The client_secret for client_secret_basic authentication.
* The `client_secret` for `client_secret_basic` authentication.
*/
clientSecret: string;
@ -110,10 +110,10 @@ export interface ClientCredentialsProviderOptions {
}
/**
* OAuth provider for client_credentials grant with client_secret_basic authentication.
* OAuth provider for `client_credentials` grant with `client_secret_basic` authentication.
*
* This provider is designed for machine-to-machine authentication where
* the client authenticates using a client_id and client_secret.
* the client authenticates using a `client_id` and `client_secret`.
*
* @example
* ```typescript
@ -189,11 +189,11 @@ export class ClientCredentialsProvider implements OAuthClientProvider {
}
/**
* Options for creating a PrivateKeyJwtProvider.
* Options for creating a {@linkcode PrivateKeyJwtProvider}.
*/
export interface PrivateKeyJwtProviderOptions {
/**
* The client_id for this OAuth client.
* The `client_id` for this OAuth client.
*/
clientId: string;
@ -220,7 +220,7 @@ export interface PrivateKeyJwtProviderOptions {
}
/**
* OAuth provider for client_credentials grant with private_key_jwt authentication.
* OAuth provider for `client_credentials` grant with `private_key_jwt` authentication.
*
* This provider is designed for machine-to-machine authentication where
* the client authenticates using a signed JWT assertion
@ -308,11 +308,11 @@ export class PrivateKeyJwtProvider implements OAuthClientProvider {
}
/**
* Options for creating a StaticPrivateKeyJwtProvider.
* Options for creating a {@linkcode StaticPrivateKeyJwtProvider}.
*/
export interface StaticPrivateKeyJwtProviderOptions {
/**
* The client_id for this OAuth client.
* The `client_id` for this OAuth client.
*/
clientId: string;
@ -320,7 +320,7 @@ export interface StaticPrivateKeyJwtProviderOptions {
* A pre-built JWT client assertion to use for authentication.
*
* This token should already contain the appropriate claims
* (iss, sub, aud, exp, etc.) and be signed by the client's key.
* (`iss`, `sub`, `aud`, `exp`, etc.) and be signed by the client's key.
*/
jwtBearerAssertion: string;
@ -331,9 +331,9 @@ export interface StaticPrivateKeyJwtProviderOptions {
}
/**
* OAuth provider for client_credentials grant with a static private_key_jwt assertion.
* OAuth provider for `client_credentials` grant with a static `private_key_jwt` assertion.
*
* This provider mirrors {@link PrivateKeyJwtProvider} but instead of constructing and
* This provider mirrors {@linkcode PrivateKeyJwtProvider} but instead of constructing and
* signing a JWT on each request, it accepts a pre-built JWT assertion string and
* uses it directly for authentication.
*/

14
packages/client/src/client/client.ts
View file

@ -68,7 +68,7 @@ import {
import { ExperimentalClientTasks } from '../experimental/tasks/client.js';
/**
* Elicitation default application helper. Applies defaults to the data based on the schema.
* Elicitation default application helper. Applies defaults to the `data` based on the `schema`.
*
* @param schema - The schema to apply defaults to.
* @param data - The data to apply defaults to.
@ -153,7 +153,7 @@ export type ClientOptions = ProtocolOptions & {
* The validator is used to validate structured content returned by tools
* against their declared output schemas.
*
* @default DefaultJsonSchemaValidator (AjvJsonSchemaValidator on Node.js, CfWorkerJsonSchemaValidator on Cloudflare Workers)
* @default {@linkcode DefaultJsonSchemaValidator} ({@linkcode index.AjvJsonSchemaValidator | AjvJsonSchemaValidator} on Node.js, {@linkcode index.CfWorkerJsonSchemaValidator | CfWorkerJsonSchemaValidator} on Cloudflare Workers)
*/
jsonSchemaValidator?: jsonSchemaValidator;
@ -189,7 +189,7 @@ export type ClientOptions = ProtocolOptions & {
/**
* An MCP client on top of a pluggable transport.
*
* The client will automatically begin the initialization flow with the server when connect() is called.
* The client will automatically begin the initialization flow with the server when {@linkcode connect} is called.
*
*/
export class Client extends Protocol<ClientContext> {
@ -713,9 +713,9 @@ export class Client extends Protocol<ClientContext> {
}
/**
* Calls a tool and waits for the result. Automatically validates structured output if the tool has an outputSchema.
* Calls a tool and waits for the result. Automatically validates structured output if the tool has an `outputSchema`.
*
* For task-based execution with streaming behavior, use client.experimental.tasks.callToolStream() instead.
* For task-based execution with streaming behavior, use {@linkcode ExperimentalClientTasks.callToolStream | client.experimental.tasks.callToolStream()} instead.
*/
async callTool(
params: CallToolRequest['params'],
@ -780,7 +780,7 @@ export class Client extends Protocol<ClientContext> {
/**
* Check if a tool requires task-based execution.
* Unlike isToolTask which includes 'optional' tools, this only checks for 'required'.
* Unlike {@linkcode isToolTask} which includes `'optional'` tools, this only checks for `'required'`.
*/
private isToolTaskRequired(toolName: string): boolean {
return this._cachedRequiredTaskTools.has(toolName);
@ -788,7 +788,7 @@ export class Client extends Protocol<ClientContext> {
/**
* Cache validators for tool output schemas.
* Called after listTools() to pre-compile validators for better performance.
* Called after {@linkcode listTools | listTools()} to pre-compile validators for better performance.
*/
private cacheToolMetadata(tools: Tool[]): void {
this._cachedToolOutputValidators.clear();

14
packages/client/src/client/middleware.ts
View file

@ -13,19 +13,19 @@ export type Middleware = (next: FetchLike) => FetchLike;
* Creates a fetch wrapper that handles OAuth authentication automatically.
*
* This wrapper will:
* - Add Authorization headers with access tokens
* - Add `Authorization` headers with access tokens
* - Handle 401 responses by attempting re-authentication
* - Retry the original request after successful auth
* - Handle OAuth errors appropriately (OAuthErrorCode.InvalidClient, etc.)
* - Handle OAuth errors appropriately ({@linkcode index.OAuthErrorCode.InvalidClient | OAuthErrorCode.InvalidClient}, etc.)
*
* The baseUrl parameter is optional and defaults to using the domain from the request URL.
* However, you should explicitly provide baseUrl when:
* The `baseUrl` parameter is optional and defaults to using the domain from the request URL.
* However, you should explicitly provide `baseUrl` when:
* - Making requests to multiple subdomains (e.g., api.example.com, cdn.example.com)
* - Using API paths that differ from OAuth discovery paths (e.g., requesting /api/v1/data but OAuth is at /)
* - The OAuth server is on a different domain than your API requests
* - You want to ensure consistent OAuth behavior regardless of request URLs
*
* For MCP transports, set baseUrl to the same URL you pass to the transport constructor.
* For MCP transports, set `baseUrl` to the same URL you pass to the transport constructor.
*
* Note: This wrapper is designed for general-purpose fetch operations.
* MCP transports (SSE and StreamableHTTP) already have built-in OAuth handling
@ -133,7 +133,7 @@ export type LoggingOptions = {
/**
* Status level filter - only log requests with status >= this value
* Set to 0 to log all requests, 400 to log only errors
* Set to `0` to log all requests, `400` to log only errors
* @default 0
*/
statusLevel?: number;
@ -145,7 +145,7 @@ export type LoggingOptions = {
* When called without arguments `withLogging()`, it uses the default logger that:
* - Logs successful requests (2xx) to `console.log`
* - Logs error responses (4xx/5xx) and network errors to `console.error`
* - Logs all requests regardless of status (statusLevel: 0)
* - Logs all requests regardless of status (`statusLevel: 0`)
* - Does not include request or response headers in logs
* - Measures and displays request duration in milliseconds
*

18
packages/client/src/client/sse.ts
View file

@ -17,7 +17,7 @@ export class SseError extends Error {
}
/**
* Configuration options for the `SSEClientTransport`.
* Configuration options for the {@linkcode SSEClientTransport}.
*/
export type SSEClientTransportOptions = {
/**
@ -26,13 +26,13 @@ export type SSEClientTransportOptions = {
* When an `authProvider` is specified and the SSE connection is started:
* 1. The connection is attempted with any existing access token from the `authProvider`.
* 2. If the access token has expired, the `authProvider` is used to refresh the token.
* 3. If token refresh fails or no access token exists, and auth is required, `OAuthClientProvider.redirectToAuthorization` is called, and an `UnauthorizedError` will be thrown from `connect`/`start`.
* 3. If token refresh fails or no access token exists, and auth is required, {@linkcode OAuthClientProvider.redirectToAuthorization} is called, and an {@linkcode UnauthorizedError} will be thrown from {@linkcode index.Protocol.connect | connect}/{@linkcode SSEClientTransport.start | start}.
*
* After the user has finished authorizing via their user agent, and is redirected back to the MCP client application, call `SSEClientTransport.finishAuth` with the authorization code before retrying the connection.
* After the user has finished authorizing via their user agent, and is redirected back to the MCP client application, call {@linkcode SSEClientTransport.finishAuth} with the authorization code before retrying the connection.
*
* If an `authProvider` is not provided, and auth is required, an `UnauthorizedError` will be thrown.
* If an `authProvider` is not provided, and auth is required, an {@linkcode UnauthorizedError} will be thrown.
*
* `UnauthorizedError` might also be thrown when sending any message over the SSE transport, indicating that the session has expired, and needs to be re-authed and reconnected.
* {@linkcode UnauthorizedError} might also be thrown when sending any message over the SSE transport, indicating that the session has expired, and needs to be re-authed and reconnected.
*/
authProvider?: OAuthClientProvider;
@ -40,14 +40,14 @@ export type SSEClientTransportOptions = {
* Customizes the initial SSE request to the server (the request that begins the stream).
*
* NOTE: Setting this property will prevent an `Authorization` header from
* being automatically attached to the SSE request, if an `authProvider` is
* being automatically attached to the SSE request, if an {@linkcode SSEClientTransportOptions.authProvider | authProvider} is
* also given. This can be worked around by setting the `Authorization` header
* manually.
*/
eventSourceInit?: EventSourceInit;
/**
* Customizes recurring POST requests to the server.
* Customizes recurring `POST` requests to the server.
*/
requestInit?: RequestInit;
@ -59,8 +59,8 @@ export type SSEClientTransportOptions = {
/**
* Client transport for SSE: this will connect to a server using Server-Sent Events for receiving
* messages and make separate POST requests for sending messages.
* @deprecated SSEClientTransport is deprecated. Prefer to use StreamableHTTPClientTransport where possible instead. Note that because some servers are still using SSE, clients may need to support both transports during the migration period.
* messages and make separate `POST` requests for sending messages.
* @deprecated SSEClientTransport is deprecated. Prefer to use {@linkcode index.StreamableHTTPClientTransport | StreamableHTTPClientTransport} where possible instead. Note that because some servers are still using SSE, clients may need to support both transports during the migration period.
*/
export class SSEClientTransport implements Transport {
private _eventSource?: EventSource;

10
packages/client/src/client/stdio.ts
View file

@ -21,14 +21,14 @@ export type StdioServerParameters = {
/**
* The environment to use when spawning the process.
*
* If not specified, the result of getDefaultEnvironment() will be used.
* If not specified, the result of {@linkcode getDefaultEnvironment} will be used.
*/
env?: Record<string, string>;
/**
* How to handle stderr of the child process. This matches the semantics of Node's `child_process.spawn`.
*
* The default is "inherit", meaning messages to stderr will be printed to the parent process's stderr.
* The default is `"inherit"`, meaning messages to stderr will be printed to the parent process's stderr.
*/
stderr?: IOType | Stream | number;
@ -164,10 +164,10 @@ export class StdioClientTransport implements Transport {
}
/**
* The stderr stream of the child process, if `StdioServerParameters.stderr` was set to "pipe" or "overlapped".
* The `stderr` stream of the child process, if {@linkcode StdioServerParameters.stderr} was set to `"pipe"` or `"overlapped"`.
*
* If stderr piping was requested, a PassThrough stream is returned _immediately_, allowing callers to
* attach listeners before the start method is invoked. This prevents loss of any early
* If `stderr` piping was requested, a `PassThrough` stream is returned _immediately_, allowing callers to
* attach listeners before the `start` method is invoked. This prevents loss of any early
* error output emitted by the child process.
*/
get stderr(): Stream | null {

22
packages/client/src/client/streamableHttp.ts
View file

@ -50,7 +50,7 @@ export interface StartSSEOptions {
}
/**
* Configuration options for reconnection behavior of the StreamableHTTPClientTransport.
* Configuration options for reconnection behavior of the {@linkcode StreamableHTTPClientTransport}.
*/
export interface StreamableHTTPReconnectionOptions {
/**
@ -79,7 +79,7 @@ export interface StreamableHTTPReconnectionOptions {
}
/**
* Configuration options for the `StreamableHTTPClientTransport`.
* Configuration options for the {@linkcode StreamableHTTPClientTransport}.
*/
export type StreamableHTTPClientTransportOptions = {
/**
@ -88,13 +88,13 @@ export type StreamableHTTPClientTransportOptions = {
* When an `authProvider` is specified and the connection is started:
* 1. The connection is attempted with any existing access token from the `authProvider`.
* 2. If the access token has expired, the `authProvider` is used to refresh the token.
* 3. If token refresh fails or no access token exists, and auth is required, `OAuthClientProvider.redirectToAuthorization` is called, and an `UnauthorizedError` will be thrown from `connect`/`start`.
* 3. If token refresh fails or no access token exists, and auth is required, {@linkcode OAuthClientProvider.redirectToAuthorization} is called, and an {@linkcode UnauthorizedError} will be thrown from {@linkcode index.Protocol.connect | connect}/{@linkcode StreamableHTTPClientTransport.start | start}.
*
* After the user has finished authorizing via their user agent, and is redirected back to the MCP client application, call `StreamableHTTPClientTransport.finishAuth` with the authorization code before retrying the connection.
* After the user has finished authorizing via their user agent, and is redirected back to the MCP client application, call {@linkcode StreamableHTTPClientTransport.finishAuth} with the authorization code before retrying the connection.
*
* If an `authProvider` is not provided, and auth is required, an `UnauthorizedError` will be thrown.
* If an `authProvider` is not provided, and auth is required, an {@linkcode UnauthorizedError} will be thrown.
*
* `UnauthorizedError` might also be thrown when sending any message over the transport, indicating that the session has expired, and needs to be re-authed and reconnected.
* {@linkcode UnauthorizedError} might also be thrown when sending any message over the transport, indicating that the session has expired, and needs to be re-authed and reconnected.
*/
authProvider?: OAuthClientProvider;
@ -122,7 +122,7 @@ export type StreamableHTTPClientTransportOptions = {
/**
* Client transport for Streamable HTTP: this implements the MCP Streamable HTTP transport specification.
* It will connect to a server using HTTP POST for sending messages and HTTP GET with Server-Sent Events
* It will connect to a server using HTTP `POST` for sending messages and HTTP `GET` with Server-Sent Events
* for receiving messages.
*/
export class StreamableHTTPClientTransport implements Transport {
@ -628,14 +628,14 @@ export class StreamableHTTPClientTransport implements Transport {
}
/**
* Terminates the current session by sending a DELETE request to the server.
* Terminates the current session by sending a `DELETE` request to the server.
*
* Clients that no longer need a particular session
* (e.g., because the user is leaving the client application) SHOULD send an
* HTTP DELETE to the MCP endpoint with the Mcp-Session-Id header to explicitly
* HTTP `DELETE` to the MCP endpoint with the `Mcp-Session-Id` header to explicitly
* terminate the session.
*
* The server MAY respond with HTTP 405 Method Not Allowed, indicating that
* The server MAY respond with HTTP `405 Method Not Allowed`, indicating that
* the server does not allow clients to terminate sessions.
*/
async terminateSession(): Promise<void> {
@ -681,7 +681,7 @@ export class StreamableHTTPClientTransport implements Transport {
/**
* Resume an SSE stream from a previous event ID.
* Opens a GET SSE connection with Last-Event-ID header to replay missed events.
* Opens a `GET` SSE connection with `Last-Event-ID` header to replay missed events.
*
* @param lastEventId The event ID to resume from
* @param options Optional callback to receive new resumption tokens

14
packages/client/src/experimental/tasks/client.ts
View file

@ -21,7 +21,7 @@ import { CallToolResultSchema, ProtocolError, ProtocolErrorCode } from '@modelco
import type { Client } from '../../client/client.js';
/**
* Internal interface for accessing Client's private methods.
* Internal interface for accessing {@linkcode Client}'s private methods.
* @internal
*/
interface ClientInternal {
@ -50,11 +50,11 @@ export class ExperimentalClientTasks {
/**
* Calls a tool and returns an AsyncGenerator that yields response messages.
* The generator is guaranteed to end with either a 'result' or 'error' message.
* The generator is guaranteed to end with either a `'result'` or `'error'` message.
*
* This method provides streaming access to tool execution, allowing you to
* observe intermediate task status updates for long-running tool calls.
* Automatically validates structured output if the tool has an outputSchema.
* Automatically validates structured output if the tool has an `outputSchema`.
*
* @example
* ```typescript
@ -78,9 +78,9 @@ export class ExperimentalClientTasks {
* ```
*
* @param params - Tool call parameters (name and arguments)
* @param resultSchema - Zod schema for validating the result (defaults to CallToolResultSchema)
* @param resultSchema - Zod schema for validating the result (defaults to {@linkcode CallToolResultSchema})
* @param options - Optional request options (timeout, signal, task creation params, etc.)
* @returns AsyncGenerator that yields ResponseMessage objects
* @returns AsyncGenerator that yields {@linkcode ResponseMessage} objects
*
* @experimental
*/
@ -235,7 +235,7 @@ export class ExperimentalClientTasks {
/**
* Sends a request and returns an AsyncGenerator that yields response messages.
* The generator is guaranteed to end with either a 'result' or 'error' message.
* The generator is guaranteed to end with either a `'result'` or `'error'` message.
*
* This method provides streaming access to request processing, allowing you to
* observe intermediate task status updates for task-augmented requests.
@ -243,7 +243,7 @@ export class ExperimentalClientTasks {
* @param request - The request to send
* @param resultSchema - Zod schema for validating the result
* @param options - Optional request options (timeout, signal, task creation params, etc.)
* @returns AsyncGenerator that yields ResponseMessage objects
* @returns AsyncGenerator that yields {@linkcode ResponseMessage} objects
*
* @experimental
*/