Repository navigation
@tanstack/ai-mcp@1.0.0
Major Changes
- #1840
f1b3f65- TanStack AI 1.0.0. This release removes every API that was deprecated in 0.x. Read the upgrade guide before you upgrade: https://tanstack.com/ai/latest/docs/migration/v1- Removed all
@deprecatedexports, options, fields, and type aliases. Each one has a replacement that already shipped in 0.x. - Removed
addToolApprovalResponse()fromChatClientand every chat hook. Resolve the boundtool-approvalinterrupt withresolveInterruptinstead. The devtools eventtools:approval:respondedis also removed. - Removed the old wire formats: the CUSTOM
approval-requestedandtool-input-availableevents, the[DONE]SSE line, thedatacopy offorwardedProps, pre-binding interrupt descriptors and theirapproval_requiredandclient_tool_inputreasons, and the STEP events that adapters sent next toREASONING_*events. Use a 1.0 client with a 1.0 server. - Removed the
toolNamealias fromTOOL_CALL_STARTchunks. ReadtoolCallNameinstead. threadIdis now required onuseChatand every other chat hook,ChatClient, the generation hooks and clients,chat(),summarize(), the generation functions,codeModeWithSnippets(),selectRelevantSnippets(),CompactionContext, andSummarizeInput. TanStack AI no longer makes a thread id for you. Pass a stable id for each conversation.createChatHookfactory options no longer takethreadId: pass it on each hook call. Octane generation hooks takethreadIdinstead ofid.@tanstack/ai-sandboxremovesresolveDurableThreadIdandDurableThreadIdRequiredError.- The published
@tanstack/ai-octane/uitypes are now strict.UI.Messages,UI.Message,UI.Part, andUI.Interruptstype their render children.ToolPropstypespart.inputandpart.outputfor the named tool.toolsComponentsandinterruptsComponentsare required when the chat options declare tools or named interrupts. Code that relied on the old loose types can fail to compile. - A connection adapter's
connect()andsend()need the run context (withthreadId) as their fourth argument.ChatClientand the generation clients pass it. @tanstack/ai-sandbox:createToolBridgeCore(),startHostToolBridge(), aToolBridgeProvisioner, andexecuteHostTool()take a requiredthreadId. Bridged tools get it in their context.@tanstack/ai-sandbox: the harness tool bridge andexecuteHostTool()refuse a tool withneedsApproval. Before, the tool ran with no approval. RemoveneedsApproval, or run the tool with an HTTP adapter.stream()andrpcStream()pass the AG-UIRunAgentInputfor the run as the fourth factory argument, the same body the HTTP adapters send. Read it on the server withchatParamsFromRequestBody()orgenerationParamsFromBody(), sothreadId,runId, and interruptresumereach a server function.RunAgentInputis exported from@tanstack/ai/client.- A generation
fetchergetsthreadIdandrunIdin its second argument, next tosignalandheaders. Pass them to the server generation call. generationParamsFromBody()andgenerationParamsFromRequest()read the generation input fromforwardedProps. A server that readsbody.datagetsundefined. Readbody.forwardedPropsinstead. They also requirethreadIdandrunIdand return them as strings, the same aschatParamsFromRequestBody()and the AG-UIRunAgentInput. A body that holds only the input is rejected.- Removed the readers for data saved in old 0.x formats (old Cloudflare run-log records, a bare
UIMessage[]from client persistence, artifact records withoutblobKey). - Removed provider models that are shut down.
@tanstack/ai-react-ui,@tanstack/ai-solid-ui, and@tanstack/ai-vue-uiget no 1.0 release. Import from@tanstack/ai-react/ui,@tanstack/ai-solid/ui, or@tanstack/ai-vue/ui.
- Removed all
Minor Changes
-
#1848
e3b2885- Serve and call MCP extensions.createMCPServertakes asetupfunction. It gets each SDKMcpServerbefore it connects, so a server can declare an extension incapabilities.extensionsand add handlers for its methods.MCPClient.requestsends any request with the SDKClient.request, including the methods of an extension. -
#1755
39c1c79- Use MCP in a TanStack AI harness.@tanstack/ai-mcp/harnessaddscreateHarnessMcpServer. It serves a harness as an MCP server, so Claude Code, Claude Desktop, Cursor, or another agent can use it. The tools arechat,steer,cancel,approve,reject,resolve,answer, andstatus, plusagent_<name>for each exposed agent andcommand_<name>for each exposed command. Every tool takes an optionalthreadId. Withapprovals: 'ask'(the default), the client asks the user about each approval when it supports elicitation. Otherwise the approvals come back in the result.approvals: 'auto'approves every tool call.resolveanswers every interrupt of a stopped turn in one call, or the waits of one background agent run. It finds the wait in the log, so it also answers a wait that another server, or a server before a restart, opened. A question takesanswer. Every result lists the open waits of its work inwaits, each with akindfromwaitKind(approval,question,sign-in,client-tool, orhuman). Thestatustool lists every wait, and each background agent withstatus: 'running'or'waiting'.- On a host with
access,createHarnessMcpServerreads the user of each HTTP request withgetUser. The host checks each tool call of that user. A host withoutaccessneedsopenAccess: true(no user) oropenAccess: { user }(one local user), else the server throws at the start. It usesrequestUsers, the same rule as the HTTP handler. Each tool call releases its session handle when it ends, so the session closes on idle. Thestatustool and the media reads read the thread withhost.observe, so they set up no plugins. The server forgets a wait when its operation settles. @tanstack/ai-mcp/harnessalso adds themcp()harness plugin. It connects stdio and HTTP servers by name, gives the model their tools as<server>_<tool>, and adds a/mcpstatus command. A stdio server starts once per host for eachmcp()object, and every session that uses that object shares it.oauth: truesigns in to a server with/connect <name>, for each user.mcp()connects again with backoff when a server closes, and lists the tools again onlist_changed. A server that fails its first connect also tries again with backoff.mcpConnectorandoauth: trueservers connect again at the next turn, and list their tools again. Each server takesneedsApprovalandtoolName. The backoff starts again only after a connection stayed open for 30 s, so a server that crashes right after it connects waits longer each time. When two servers give a tool with the same name,mcp()warns once. WithonDuplicateTool: 'error', the later server fails instead, with an error that names both servers and the tool.@tanstack/ai-mcp/connectoraddsmcpConnector: one OAuth MCP server as a harness plugin, withneedsApproval,prefix,scopes, andclientName. The sign-in passes theissof the callback on (RFC 9207). A cancel or a session close stops a running sign-in at once: the loopback stops listening, and the OAuth requests abort. When the MCP SDK refreshes a token, the connector saves it withcredentials.refreshof the harness: to the scope of the sign-in, and with compare-and-set when the store has it. Each session still sends its own refresh request. When the server refuses a token, the connector deletes the saved sign-in only if it is the token that this session used. When the user signs out while the SDK refreshes, the connector saves no new token, and the call asks for a sign-in.mcp()andmcpConnectoranswer theelicitation/createrequests of MCP spec 2025 servers, and the input requests of spec 2026-07-28 servers, as session questions. One tool call can ask up to 5 times. Each question is a live wait of the run that made the tool call: it endscancelledwhen that run stops.mcp()tracks the live questions for each server, so each question goes to the run that called the tool. A spec 2025 request goes to the user only when all the running calls of that server belong to one run. Else the server getsdecline.
@tanstack/ai-harnessis an optional peer dependency. Only the./harnessand./connectorentries need it. -
#1850
52cb02d- Reuse a protocol2026-07-28server/discoverresult.MCPClient.getDiscoverResult()returns the result of the connection, or the adopted prior.createMCPClient({ prior })passes a saved one to the SDKClient.connect, so the client skips theserver/discoverrequest.DiscoverResultandPriorDiscoveryare exported as types. -
#1849
a99204a-createMCPServer({ setup })gets thehandlecontext of the request as its second argument, so an extension handler or an instrumentation hook can read the caller. A spec 2025 session withsessions: 'memory'gets the context of the request that opened it. -
#1816
3e84606- Add experimental MCP Events (SEP-3415) webhook support.createMCPClient({ experimental_events: { store } | { adapter } })addsclient.experimental_eventswithlist,subscribe,refreshandunsubscribe(direct) or adapter-delegated operations (managed).- New
@tanstack/ai-mcp/eventssubpath:createMCPEventWebhook,inMemoryMCPEventStore,createMCPEventSecret,signMCPEventPayload.
-
#1883
39abb7e- Core support for the harness: subagent binding options, theonGuardToolCallhook, server-side BYOK keys, harness tool runs, checked streamedoutputSchemaresults, and resume fixes.Add the harness asks from the fifth findings list.
chat({ outputSchema, stream: true })now checks the full result against a Standard Schema. A failure ends withRUN_ERRORstructured-output-validation-failed, with the model text inmetadata.tanstack.rawText.session.send(prompt, { outputSchema })gives the turn a typedstructuredvalue. It is per send only, and the HTTP handler does not take it.- A server tool reads run capabilities with
context.get(capability)andcontext.getOptional(capability), for example the sandbox underwithSandbox. - Readers keep the full history after a durable compaction.
session.transcript(),GET transcript, and the chat hydration show every message. The model still gets the compacted context. createHarnessHost({ acceptInput })sees each input after the access check and before the log keeps it. It can change the input or refuse it.- A plugin
adapter()pick withoverride: truewins over the stored thread model. onModelErrorcan return{ retry: true, adapter }to retry on another model.ModelErrorContexthasadapterandmodel.- Middleware reads
ctx.context.run.sourceandlabelto tell a turn call from a plugin, router, or transfer call. host.sessions.archive()andunarchive(). Lists hide archived threads unless you passwithArchived: true.host.sessions.eraseUser({ harness, threadId, userId, replies })replaces one person's messages with[removed], deletes their media, and cuts the log before a new snapshot. The neweraseaccess action guards it.HarnessRecordis exported, for a typedLogStorewrapper.- Coding-tool file calls pass their abort signal through
WorkspaceBackendto the sandbox. withCompactionlimits (maxTokens,contextWindow,background.atTokens) can be a function of{ model }.
Run a harness tool with no model turn, add host records from a client, and add a per-run system preamble.
session.runTool({ name, args?, meta?, inputId?, user? })runs one harness tool with no model
turn, for example from a schedule or a webhook. The call goes through the
same middleware, input check, andpermissions()rules as a model call, and
the call and its result join the transcript. A tool that asks for approval
stops the turn with an interrupt. While interrupts wait, the call is refused
withpending_interrupts.metais echoed as atanstack.injectioncustom
event.argsis typed from the input schema of a harness tool.expose.toolslists the harness tools a client may run with a
{ op: 'tool', name, args?, meta? }input, or with the new
client.runTool({ name, args?, meta?, inputId? }). The list is typed from the harness
tools, anddefineHarnessthrows for a name that is not intools. Any
other tool is refused withnot_exposed. The capabilities document marks
each tool withexposed.expose.recordslists the host record types a client may add with an
{ op: 'append', records }input, or with the newclient.appendRecords({ records }).
A record of another type, or with athreadfield, is refused with
not_exposed. The session log keeps the records.createHarnessMcpServeradds atool_<name>tool for each tool in
expose.tools, and anappendtool whenexpose.recordshas types. A tool
input with its ownthreadIdfield throws when the server is created,
because MCP usesthreadIdto pick the thread.session.send(message, { systemPreamble })prepends per-run, server-only
system prompts ahead of the harness's own system prompts (for example
host-provided memory). A client input cannot set them.- A tool call in a harness turn gets
threadIdandrunIdin its execution
context.ToolExecutionContextin@tanstack/aihas the two new optional
fields for a host to set.
A host can add fields to the
ctxan agent'srungets.subagents.binding.extend(ctx)returns the fields to add. A child'sctx.chat({ subagents })passes it down, so the fields reach nested children too.SubagentContextExtensionis an empty interface thatSubagentRunContextincludes. A package augments it to type its fields, for examplectx.harnessfrom@tanstack/ai-harness. Make each field optional, because a run that a plainchat()starts has no host.
Add
interruptstoSubagentBinding.- A host sets
binding.interruptsto give interrupt definitions to everyctx.chatcall of an agent run. Then the host middleware inchatMiddlewarecan stop the child with these interrupts. - The own
interruptsof the call win. When a host definition has the same id as one of the call, the host definition is not added. - A child's
ctx.chat({ subagents })passes the definitions on to its own children. - A plain
chat()call does not get them.
Add
lastChatMiddlewaretoSubagentBinding. It runs after the own middleware of eachctx.chatcall of an agent run, so it sees the final model context and tool results. A child'sctx.chat({ subagents })passes it on, after the child's own.Add
validateJsonSchema(schema, value). It checks a value against a JSON Schema with@cfworker/json-schema, as a tool input is checked, but with no repair. The result has the Standard Schema shape:{ value }or{ issues }. The root also exports theStandardSchemaV1andStandardJSONSchemaV1types.An agent
runthat throws the shape ofMCPInputRequiredError(name,kind,request) stops the child assuspended, as a tool does, and the parent run stops with its interrupt. The interrupt has a generic binding and no tool call. Its id is theinterruptIdof the thrown value, elsemcp_input_<subagentRunId>, and its message is the error message. The resume runs the child again, andctx.resumehas the answer.Add
SubagentBinding.debug, thedebugoption for the model calls of child agents that set nodebugof their own.Add the
onGuardToolCallmiddleware hook for checks that must always run, such as permissions.- It runs for every tool call, after all
onBeforeToolCallhooks and after theinputSchemacheck.hookCtx.argsholds the final checked arguments that the tool gets. - The guard of every middleware runs, in order, until one returns a decision. An earlier
onBeforeToolCalldecision does not skip it. - Return
{ type: 'skip', result }to deny the call. The tool does not run, and the model getsresult, the same as anonBeforeToolCallskip. Return{ type: 'abort', reason }to abort the run. - It runs before a server tool runs and before a client tool goes to the client. A guard cannot change the arguments.
- The new
GuardToolCallDecisiontype is exported.
BYOK keys can now live on the server.
@tanstack/ai/byokexports theCredentialStorecontract, theCredentialandCredentialScopetypes, anddefineCredentialStore. ACredentialScopehastenantIdanduserId. ItsthreadIdis optional, and a store ignores it.@tanstack/ai/byok/serveradds:storedProviderKeys(store, scope): provider keys from theapi_keycredentials of a user, then of the tenant, then the provider'senvnames. Passkeys.adapter(...)tochat()andkeys.gettosubagents.keys.readCredential(store, scope, id): one credential, the user's own first, then the tenant's. A user with no tenant reads only their own.tenantScopeOf(scope): the tenant scope of a user scope, orundefinedwhen the scope has no user or no tenant.memoryCredentialStore(): a store in memory, for development and tests.envKeyEntry(provider): the firstprovider.envname that is set, with its value.readCredentialEntry(store, scope, id): reads a credential likereadCredential. It also tells you which scope had the credential (the user or the tenant), and gives its revision when the store hasgetVersioned.
CredentialStorehas two optional methods for compare-and-set writes,getVersionedandsetIf, with the same shape as the pair onMetadataStore. A store without them still works.memoryCredentialStorehas both.Keep the store in your own database or in a secrets manager, and encrypt the secrets at rest. An
oauthcredential can keep the OAuthclientit was issued to.listnever returns secret values.scrubSecretsfrom@tanstack/ai/byoknow also removes the JSON-escaped and URL-encoded forms of each secret. It skips a secret that is shorter than 6 characters, so a short value does not remove common words.Credentialhas a new type,secret_answer({ value, expiresAt }). The harness keeps a secret answer to a question there for a short time and deletes it once read. Leave this type out of a list of connected accounts.memoryCredentialStore().listreturns itsexpiresAt.Approved edits to tool arguments stay raw until the final input check.
@tanstack/ai: a resume no longer rejects approvededitedArgsthat do not fit the tool'sinputSchema. The edit goes throughonBeforeToolCalland the final input check, like the model's arguments. If it still does not fit, the approval is used, the tool does not run, and the model gets the input error as the tool result. The transcript keeps the approved edit as it was sent, but only when the call passed the check.@tanstack/ai-persistence:withPersistencebinds the client-tool phase of an approved tool call to its approval. After a restart, the client result resumes with the approval that came before it, and a stale or missing approval fails the resume.
A nested subagent that waits on an interrupt now continues after the resume under
withPersistence. Before, it ran again from its prompt. Core rebuilds the card of the nested child from the store and takes only its id from the client card.LoadChildtakes an optionalparentSubagentRunId, and returnsinterruptIdsandparentToolCallId.chat()asks the middlewareonShouldContinueafter it runs the pending tool calls of a resume, before the next model call. A middleware that returnsfalsethere ends the run with no more model calls. The loop strategy is not asked at that point.WebSocketLikehas an optionalbufferedAmount. A server can read it to stop sending to a slow socket. A socket without it works as before.
Patch Changes
-
#1871
d980ce1- Send theMcp-Param-*headers on spec 2026-07-28 tool calls. A tool argument marked withx-mcp-headerin the input schema is now copied to its header, so strict servers such as GitHub's remote MCP server accept the call. Spec 2026 calls now go through the SDKClient.callTool, and use the SDK timeout, abort, and progress handling. -
#1755
39c1c79- Themcp(),codeMode(), andskills()harness plugins send their warnings to the logger of the host (createHarnessHost({ logger })). -
Updated dependencies [
fcbd199,39c1c79,39c1c79,959f43e,a5c2af3,39c1c79,39c1c79,fa2a291,f7e7cce,7a0a48b,468063c,fe83aa0,781a3a8,39abb7e,f1b3f65]:- @tanstack/ai@1.0.0
- @tanstack/ai-harness@0.1.0