@devries-cameron20 / composio-1 / commits / 605a7263a
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

Add tool router session deletion (#3679)

## Summary Explain the motivation and context for this change. Link to any related issues. Fixes # ## Changes - - ## Type of change - [ ] Bug fix - [ ] New feature - [ ] Refactor/Chore - [ ] Documentation - [ ] Breaking change ## How Has This Been Tested? Describe the tests you ran and instructions so reviewers can reproduce. Include any relevant config/versions. ## Screenshots (if applicable) ## Checklist - [ ] I have read the Code of Conduct and this PR adheres to it - [ ] I ran linters/tests locally and they passed - [ ] I updated documentation as needed - [ ] I added tests or explain why not applicable - [ ] I added a changeset if this change affects published packages ## Additional context --------- Co-authored-by: jkomyno <alberto@composio.dev>

Abir Taheer committed Jun 26, 2026 at 01:38 UTC 605a7263ab3b83572f3a17f3020dc873bc7f9dfd
6 files changed +132
.changeset/great-rivers-delete.md new
+5
@@ -0,0 +1,5 @@
1 +---
2 +"@composio/core": patch
3 +---
4 +
5 +Add Tool Router session deletion APIs.
ts/packages/core/src/lib/toolRouterSessionDelete.ts new
+30
@@ -0,0 +1,30 @@
1 +import type ComposioClient from '@composio/client';
2 +import type { ComposioRequestOptions } from '../types/requestOptions.types';
3 +import type { ToolRouterSessionDeleteResponse } from '../types/toolRouter.types';
4 +import { ToolRouterSessionDeleteResponseSchema } from '../types/toolRouter.types';
5 +import { withCancellation } from '../utils/cancellation';
6 +
7 +type ToolRouterSessionDeleteWireResponse = {
8 + session_id: string;
9 + deleted: true;
10 +};
11 +
12 +export async function deleteToolRouterSession(
13 + client: ComposioClient,
14 + sessionId: string,
15 + requestOptions?: ComposioRequestOptions
16 +): Promise<ToolRouterSessionDeleteResponse> {
17 + const response = await withCancellation(
18 + () =>
19 + client.delete<ToolRouterSessionDeleteWireResponse>(
20 + `/api/v3.1/tool_router/session/${encodeURIComponent(sessionId)}`,
21 + requestOptions
22 + ),
23 + requestOptions?.signal
24 + );
25 +
26 + return ToolRouterSessionDeleteResponseSchema.parse({
27 + sessionId: response.session_id,
28 + deleted: response.deleted,
29 + });
30 +}
ts/packages/core/src/models/ToolRouter.ts
+15
@@ -29,6 +29,7 @@ import {
29 ToolRouterMCPServerConfig,
30 ToolRouterSessionMetadata,
31 SessionPreset,
32 + type ToolRouterSessionDeleteResponse,
33 } from '../types/toolRouter.types';
34 import { ToolRouterCreateSessionConfigSchema } from '../types/toolRouter.types';
35 import {
@@ -55,6 +56,7 @@ import { PRELOAD_TOOLS_ALL } from '../lib/toolRouterConstants';
56 import { ToolRouterSession } from './ToolRouterSession';
57 import { ComposioRequestOptions } from '../types/requestOptions.types';
58 import { withCancellation } from '../utils/cancellation';
59 +import { deleteToolRouterSession } from '../lib/toolRouterSessionDelete';
60 import {
61 assertNoCustomToolSlugsInPreload,
62 buildCustomToolsMap,
@@ -388,4 +390,17 @@ export class ToolRouter<
390 metadata
391 );
392 }
393 +
394 + /**
395 + * Delete a tool router session by ID.
396 + *
397 + * Deleted sessions immediately stop being retrievable or executable. Deleting
398 + * a missing or already-deleted session surfaces the backend 404.
399 + */
400 + async delete(
401 + id: string,
402 + requestOptions?: ComposioRequestOptions
403 + ): Promise<ToolRouterSessionDeleteResponse> {
404 + return deleteToolRouterSession(this.client, id, requestOptions);
405 + }
406 }
ts/packages/core/src/models/ToolRouterSession.ts
+12
@@ -22,6 +22,7 @@ import {
22 ToolRouterSessionWarning,
23 ToolRouterUpdateSessionConfig,
24 ToolRouterUpdateSessionConfigSchema,
25 + type ToolRouterSessionDeleteResponse,
26 } from '../types/toolRouter.types';
27 import {
28 transformSearchResponse,
@@ -71,6 +72,7 @@ import {
72 import { transformProxyParams } from './proxyParamsTransform';
73 import { inlineCustomToolsExperimental } from './inlineCustomToolsPayload';
74 import { transformToolRouterUpdateParams } from '../lib/toolRouterParams';
75 +import { deleteToolRouterSession } from '../lib/toolRouterSessionDelete';
76
77 const COMPOSIO_MULTI_EXECUTE_TOOL = 'COMPOSIO_MULTI_EXECUTE_TOOL';
78 export const DIRECT_CUSTOM_TOOL_DESCRIPTION_PREFIX =
@@ -647,6 +649,16 @@ export class ToolRouterSession<
649 this.warnings = response.warnings ?? [];
650 }
651
652 + /**
653 + * Delete this session.
654 + *
655 + * Deleted sessions immediately stop being retrievable or executable. Deleting
656 + * an already-deleted session surfaces the backend 404.
657 + */
658 + async delete(requestOptions?: ComposioRequestOptions): Promise<ToolRouterSessionDeleteResponse> {
659 + return deleteToolRouterSession(this.client, this.sessionId, requestOptions);
660 + }
661 +
662 // ── Private helpers ──────────────────────────────────────────
663
664 /** Check if this session has any custom tools bound. */
ts/packages/core/src/types/toolRouter.types.ts
+13
@@ -2,6 +2,7 @@ import z from 'zod/v3';
2 import type { BaseComposioProvider } from '../provider/BaseProvider';
3 import { SessionMetaToolOptions } from './modifiers.types';
4 import { ConnectionRequest } from './connectionRequest.types';
5 +import type { ComposioRequestOptions } from './requestOptions.types';
6 import type { ToolRouterSessionFilesMount } from '../models/ToolRouterSessionFileMount';
7 import type { SessionCreateResponse } from '@composio/client/resources/tool-router/session/session.mjs';
8 import type {
@@ -700,6 +701,16 @@ export type ToolRouterUpdateSessionConfig = z.infer<typeof ToolRouterUpdateSessi
701
702 export type ToolRouterSessionUpdateFn = (config: ToolRouterUpdateSessionConfig) => Promise<void>;
703
704 +export const ToolRouterSessionDeleteResponseSchema = z.object({
705 + sessionId: z.string(),
706 + deleted: z.literal(true),
707 +});
708 +export type ToolRouterSessionDeleteResponse = z.infer<typeof ToolRouterSessionDeleteResponseSchema>;
709 +
710 +export type ToolRouterSessionDeleteFn = (
711 + requestOptions?: ComposioRequestOptions
712 +) => Promise<ToolRouterSessionDeleteResponse>;
713 +
714 /** Session type returned by ToolRouter.create() and ToolRouter.use() */
715 export interface Session<
716 TToolCollection,
@@ -735,6 +746,8 @@ export interface Session<
746 execute: ToolRouterSessionExecuteFn;
747 /** Update the session configuration. Mutates this session in-place. */
748 update: ToolRouterSessionUpdateFn;
749 + /** Delete the session. Deleted sessions are no longer retrievable or executable. */
750 + delete: ToolRouterSessionDeleteFn;
751 /** Proxy an API call through Composio's auth layer using the session's connected account */
752 proxyExecute: ToolRouterSessionProxyExecuteFn;
753 /** List custom tools registered in this session, with their final slugs and schemas */
ts/packages/core/test/models/toolRouter.test.ts
+57
@@ -40,6 +40,7 @@ const createMockClient = () => ({
40 baseURL: 'https://api.composio.dev',
41 apiKey: 'test-api-key',
42 post: vi.fn(),
43 + delete: vi.fn(),
44 toolRouter: {
45 session: {
46 create: vi.fn(),
@@ -3244,6 +3245,41 @@ describe('ToolRouter', () => {
3245 });
3246 });
3247
3248 + describe('delete method', () => {
3249 + it('should delete a session by ID and return a camelCase response', async () => {
3250 + mockClient.delete.mockResolvedValueOnce({
3251 + session_id: 'trs_delete_123',
3252 + deleted: true,
3253 + });
3254 +
3255 + const result = await toolRouter.delete('trs_delete_123');
3256 +
3257 + expect(mockClient.delete).toHaveBeenCalledWith(
3258 + '/api/v3.1/tool_router/session/trs_delete_123',
3259 + undefined
3260 + );
3261 + expect(result).toEqual({
3262 + sessionId: 'trs_delete_123',
3263 + deleted: true,
3264 + });
3265 + });
3266 +
3267 + it('should forward request options when deleting by ID', async () => {
3268 + const requestOptions = { signal: new AbortController().signal };
3269 + mockClient.delete.mockResolvedValueOnce({
3270 + session_id: 'trs_delete_123',
3271 + deleted: true,
3272 + });
3273 +
3274 + await toolRouter.delete('trs_delete_123', requestOptions);
3275 +
3276 + expect(mockClient.delete).toHaveBeenCalledWith(
3277 + '/api/v3.1/tool_router/session/trs_delete_123',
3278 + requestOptions
3279 + );
3280 + });
3281 + });
3282 +
3283 describe('use method', () => {
3284 const sessionId = 'session_123';
3285
@@ -3267,6 +3303,7 @@ describe('ToolRouter', () => {
3303 expect(session).toHaveProperty('tools');
3304 expect(session).toHaveProperty('authorize');
3305 expect(session).toHaveProperty('toolkits');
3306 + expect(session).toHaveProperty('delete');
3307 expect(session.preload.tools).toEqual(['GMAIL_FETCH_EMAILS']);
3308 expect(session.configVersion).toBe(7);
3309 });
@@ -3398,6 +3435,26 @@ describe('ToolRouter', () => {
3435 expect(toolkitsResult.items[0].slug).toBe('gmail');
3436 });
3437
3438 + it('should return a session with working delete function', async () => {
3439 + mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(mockSessionRetrieveResponse);
3440 + mockClient.delete.mockResolvedValueOnce({
3441 + session_id: sessionId,
3442 + deleted: true,
3443 + });
3444 +
3445 + const session = await toolRouter.use(sessionId);
3446 + const result = await session.delete();
3447 +
3448 + expect(mockClient.delete).toHaveBeenCalledWith(
3449 + '/api/v3.1/tool_router/session/session_123',
3450 + undefined
3451 + );
3452 + expect(result).toEqual({
3453 + sessionId,
3454 + deleted: true,
3455 + });
3456 + });
3457 +
3458 it('should attach custom tools and expose SDK-preloaded custom schemas', async () => {
3459 const grepTool = createCustomTool('GREP', {
3460 name: 'Grep',