Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
fix(core): attach existing tool router sessions
Abir Taheer committed
May 7, 2026 at 02:05 UTC
dd98d52f018ace759b5da8d7731efec330eb0ecc
2 files changed
+74
-26
ts/packages/core/src/models/ToolRouter.ts
+10
-9
@@ -35,7 +35,11 @@ import {
35
SessionCreateResponse,
36
SessionRetrieveResponse,
37
} from '@composio/client/resources/tool-router/session/session.mjs';
38
-import type { CustomTool, CustomToolkit, InlineCustomToolsWirePayload } from '../types/customTool.types';
38
+import type {
39
+ CustomTool,
40
+ CustomToolkit,
41
+ InlineCustomToolsWirePayload,
42
+} from '../types/customTool.types';
43
import {
44
transformToolRouterTagsParams,
45
transformToolRouterToolsParams,
@@ -252,7 +256,6 @@ export class ToolRouter<
256
const customToolkits = options?.customToolkits;
257
const hasCustoms = !!(customTools?.length || customToolkits?.length);
258
255
- let session: SessionRetrieveResponse;
259
let inlineCustomToolsPayload: InlineCustomToolsWirePayload | undefined;
260
261
if (hasCustoms) {
@@ -265,15 +268,13 @@ export class ToolRouter<
268
custom_tools: serializedTools,
269
custom_toolkits: serializedToolkits,
270
};
268
-
269
- session = await this.client.post<SessionRetrieveResponse>(
270
- `/api/v3.1/tool_router/session/${encodeURIComponent(id)}/attach`,
271
- { body: { experimental: inlineCustomToolsPayload } }
272
- );
273
- } else {
274
- session = await this.client.toolRouter.session.retrieve(id);
271
}
272
273
+ const session = await this.client.post<SessionRetrieveResponse>(
274
+ `/api/v3.1/tool_router/session/${encodeURIComponent(id)}/attach`,
275
+ { body: inlineCustomToolsPayload ? { experimental: inlineCustomToolsPayload } : {} }
276
+ );
277
+
278
let customToolsMap: CustomToolsMap | undefined;
279
let userId: string | undefined;
280
if (hasCustoms) {
ts/packages/core/test/models/toolRouter.test.ts
+64
-17
@@ -31,6 +31,7 @@ vi.mock('../../src/models/Tools', () => {
31
const createMockClient = () => ({
32
baseURL: 'https://api.composio.dev',
33
apiKey: 'test-api-key',
34
+ post: vi.fn(),
35
toolRouter: {
36
session: {
37
create: vi.fn(),
@@ -2918,13 +2919,16 @@ describe('ToolRouter', () => {
2919
2920
describe('use method', () => {
2921
const sessionId = 'session_123';
2922
+ const attachEndpoint = (id: string) =>
2923
+ `/api/v3.1/tool_router/session/${encodeURIComponent(id)}/attach`;
2924
2922
- it('should retrieve an existing session by ID', async () => {
2923
- mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(mockSessionRetrieveResponse);
2925
+ it('should attach an existing session by ID', async () => {
2926
+ mockClient.post.mockResolvedValueOnce(mockSessionRetrieveResponse);
2927
2928
const session = await toolRouter.use(sessionId);
2929
2927
- expect(mockClient.toolRouter.session.retrieve).toHaveBeenCalledWith(sessionId);
2930
+ expect(mockClient.post).toHaveBeenCalledWith(attachEndpoint(sessionId), { body: {} });
2931
+ expect(mockClient.toolRouter.session.retrieve).not.toHaveBeenCalled();
2932
expect(session).toHaveProperty('sessionId', 'session_123');
2933
expect(session).toHaveProperty('mcp');
2934
expect(session.mcp).toEqual({
@@ -2941,6 +2945,46 @@ describe('ToolRouter', () => {
2945
expect(session.configVersion).toBe(7);
2946
});
2947
2948
+ it('should attach custom tools when provided', async () => {
2949
+ const grepTool = createCustomTool('GREP', {
2950
+ name: 'Grep',
2951
+ description: 'Search local text',
2952
+ inputParams: z.object({ pattern: z.string() }),
2953
+ execute: vi.fn(async () => ({ matches: [] })),
2954
+ });
2955
+
2956
+ mockClient.post.mockResolvedValueOnce({
2957
+ ...mockSessionRetrieveResponse,
2958
+ experimental: {
2959
+ custom_tools: [
2960
+ {
2961
+ slug: 'SERVER_GREP',
2962
+ original_slug: 'GREP',
2963
+ extends_toolkit: null,
2964
+ },
2965
+ ],
2966
+ },
2967
+ });
2968
+
2969
+ const session = await toolRouter.use(sessionId, { customTools: [grepTool] });
2970
+
2971
+ expect(mockClient.post).toHaveBeenCalledWith(attachEndpoint(sessionId), {
2972
+ body: {
2973
+ experimental: {
2974
+ custom_tools: [expect.objectContaining({ slug: 'GREP' })],
2975
+ custom_toolkits: undefined,
2976
+ },
2977
+ },
2978
+ });
2979
+ expect(mockClient.toolRouter.session.retrieve).not.toHaveBeenCalled();
2980
+ expect(session.customTools()).toEqual([
2981
+ expect.objectContaining({
2982
+ slug: 'SERVER_GREP',
2983
+ name: 'Grep',
2984
+ }),
2985
+ ]);
2986
+ });
2987
+
2988
it('should return a session with correct session ID', async () => {
2989
const customResponse = {
2990
...mockSessionRetrieveResponse,
@@ -2950,7 +2994,7 @@ describe('ToolRouter', () => {
2994
},
2995
};
2996
2953
- mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(customResponse);
2997
+ mockClient.post.mockResolvedValueOnce(customResponse);
2998
2999
const session = await toolRouter.use(sessionId);
3000
@@ -2960,7 +3004,7 @@ describe('ToolRouter', () => {
3004
});
3005
3006
it('should return a session with working tools function', async () => {
2963
- mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(mockSessionRetrieveResponse);
3007
+ mockClient.post.mockResolvedValueOnce(mockSessionRetrieveResponse);
3008
3009
const session = await toolRouter.use(sessionId);
3010
@@ -2979,7 +3023,7 @@ describe('ToolRouter', () => {
3023
});
3024
3025
it('should return a session with working authorize function', async () => {
2982
- mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(mockSessionRetrieveResponse);
3026
+ mockClient.post.mockResolvedValueOnce(mockSessionRetrieveResponse);
3027
mockClient.toolRouter.session.link.mockResolvedValueOnce(mockLinkResponse);
3028
3029
const session = await toolRouter.use(sessionId);
@@ -2994,7 +3038,7 @@ describe('ToolRouter', () => {
3038
});
3039
3040
it('should return a session with working toolkits function', async () => {
2997
- mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(mockSessionRetrieveResponse);
3041
+ mockClient.post.mockResolvedValueOnce(mockSessionRetrieveResponse);
3042
mockClient.toolRouter.session.toolkits.mockResolvedValueOnce(mockToolkitsResponse);
3043
3044
const session = await toolRouter.use(sessionId);
@@ -3022,7 +3066,7 @@ describe('ToolRouter', () => {
3066
session_id: 'session_2',
3067
};
3068
3025
- mockClient.toolRouter.session.retrieve
3069
+ mockClient.post
3070
.mockResolvedValueOnce(session1Response)
3071
.mockResolvedValueOnce(session2Response);
3072
@@ -3031,11 +3075,13 @@ describe('ToolRouter', () => {
3075
3076
expect(session1.sessionId).toBe('session_1');
3077
expect(session2.sessionId).toBe('session_2');
3034
- expect(mockClient.toolRouter.session.retrieve).toHaveBeenCalledTimes(2);
3078
+ expect(mockClient.post).toHaveBeenCalledTimes(2);
3079
+ expect(mockClient.post).toHaveBeenNthCalledWith(1, attachEndpoint('session_1'), { body: {} });
3080
+ expect(mockClient.post).toHaveBeenNthCalledWith(2, attachEndpoint('session_2'), { body: {} });
3081
});
3082
3083
it('should handle MCP server type correctly', async () => {
3038
- mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(mockSessionRetrieveResponse);
3084
+ mockClient.post.mockResolvedValueOnce(mockSessionRetrieveResponse);
3085
3086
const session = await toolRouter.use(sessionId);
3087
@@ -3043,21 +3089,21 @@ describe('ToolRouter', () => {
3089
expect(session.mcp.url).toBe('https://mcp.example.com/session_123');
3090
});
3091
3046
- it('should throw error if session retrieve fails', async () => {
3092
+ it('should throw error if session attach fails', async () => {
3093
const error = new Error('Session not found');
3048
- mockClient.toolRouter.session.retrieve.mockRejectedValueOnce(error);
3094
+ mockClient.post.mockRejectedValueOnce(error);
3095
3096
await expect(toolRouter.use(sessionId)).rejects.toThrow('Session not found');
3051
- expect(mockClient.toolRouter.session.retrieve).toHaveBeenCalledWith(sessionId);
3097
+ expect(mockClient.post).toHaveBeenCalledWith(attachEndpoint(sessionId), { body: {} });
3098
});
3099
3054
- it('should handle retrieve with different tool lists', async () => {
3100
+ it('should handle attach with different tool lists', async () => {
3101
const customResponse = {
3102
...mockSessionRetrieveResponse,
3103
tool_router_tools: ['CUSTOM_TOOL_1', 'CUSTOM_TOOL_2'],
3104
};
3105
3060
- mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(customResponse);
3106
+ mockClient.post.mockResolvedValueOnce(customResponse);
3107
3108
const session = await toolRouter.use(sessionId);
3109
@@ -3067,7 +3113,7 @@ describe('ToolRouter', () => {
3113
3114
it('should be independent from create method', async () => {
3115
mockClient.toolRouter.session.create.mockResolvedValueOnce(mockSessionCreateResponse);
3070
- mockClient.toolRouter.session.retrieve.mockResolvedValueOnce(mockSessionRetrieveResponse);
3116
+ mockClient.post.mockResolvedValueOnce(mockSessionRetrieveResponse);
3117
3118
// Create a new session
3119
const createdSession = await toolRouter.create('user_123');
@@ -3079,7 +3125,8 @@ describe('ToolRouter', () => {
3125
3126
// Both should have been called once
3127
expect(mockClient.toolRouter.session.create).toHaveBeenCalledTimes(1);
3082
- expect(mockClient.toolRouter.session.retrieve).toHaveBeenCalledTimes(1);
3128
+ expect(mockClient.post).toHaveBeenCalledTimes(1);
3129
+ expect(mockClient.toolRouter.session.retrieve).not.toHaveBeenCalled();
3130
});
3131
});
3132
});