bdbb39a0f5
Add gateway-first pattern: when AGILITON_API_KEY is set, route all external API calls through the gateway with X-API-Key auth. Falls back to direct API access when gateway is unavailable. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
83 lines
3.3 KiB
TypeScript
83 lines
3.3 KiB
TypeScript
/**
|
|
* Experimental server task features for MCP SDK.
|
|
* WARNING: These APIs are experimental and may change without notice.
|
|
*
|
|
* @experimental
|
|
*/
|
|
import type { Server } from '../../server/index.js';
|
|
import type { RequestOptions } from '../../shared/protocol.js';
|
|
import type { ResponseMessage } from '../../shared/responseMessage.js';
|
|
import type { AnySchema, SchemaOutput } from '../../server/zod-compat.js';
|
|
import type { ServerRequest, Notification, Request, Result, GetTaskResult, ListTasksResult, CancelTaskResult } from '../../types.js';
|
|
/**
|
|
* Experimental task features for low-level MCP servers.
|
|
*
|
|
* Access via `server.experimental.tasks`:
|
|
* ```typescript
|
|
* const stream = server.experimental.tasks.requestStream(request, schema, options);
|
|
* ```
|
|
*
|
|
* For high-level server usage with task-based tools, use `McpServer.experimental.tasks` instead.
|
|
*
|
|
* @experimental
|
|
*/
|
|
export declare class ExperimentalServerTasks<RequestT extends Request = Request, NotificationT extends Notification = Notification, ResultT extends Result = Result> {
|
|
private readonly _server;
|
|
constructor(_server: Server<RequestT, NotificationT, ResultT>);
|
|
/**
|
|
* Sends a request and returns an AsyncGenerator that yields response messages.
|
|
* 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.
|
|
*
|
|
* @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
|
|
*
|
|
* @experimental
|
|
*/
|
|
requestStream<T extends AnySchema>(request: ServerRequest | RequestT, resultSchema: T, options?: RequestOptions): AsyncGenerator<ResponseMessage<SchemaOutput<T>>, void, void>;
|
|
/**
|
|
* Gets the current status of a task.
|
|
*
|
|
* @param taskId - The task identifier
|
|
* @param options - Optional request options
|
|
* @returns The task status
|
|
*
|
|
* @experimental
|
|
*/
|
|
getTask(taskId: string, options?: RequestOptions): Promise<GetTaskResult>;
|
|
/**
|
|
* Retrieves the result of a completed task.
|
|
*
|
|
* @param taskId - The task identifier
|
|
* @param resultSchema - Zod schema for validating the result
|
|
* @param options - Optional request options
|
|
* @returns The task result
|
|
*
|
|
* @experimental
|
|
*/
|
|
getTaskResult<T extends AnySchema>(taskId: string, resultSchema?: T, options?: RequestOptions): Promise<SchemaOutput<T>>;
|
|
/**
|
|
* Lists tasks with optional pagination.
|
|
*
|
|
* @param cursor - Optional pagination cursor
|
|
* @param options - Optional request options
|
|
* @returns List of tasks with optional next cursor
|
|
*
|
|
* @experimental
|
|
*/
|
|
listTasks(cursor?: string, options?: RequestOptions): Promise<ListTasksResult>;
|
|
/**
|
|
* Cancels a running task.
|
|
*
|
|
* @param taskId - The task identifier
|
|
* @param options - Optional request options
|
|
*
|
|
* @experimental
|
|
*/
|
|
cancelTask(taskId: string, options?: RequestOptions): Promise<CancelTaskResult>;
|
|
}
|
|
//# sourceMappingURL=server.d.ts.map
|