Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
fix(python): attach existing tool router sessions
Abir Taheer26eda4606d16
diff --git a/python/composio/core/models/tool_router.py b/python/composio/core/models/tool_router.pyindex 06b53628c..975f5e18e 100644--- a/python/composio/core/models/tool_router.py+++ b/python/composio/core/models/tool_router.py@@ -1000,9 +1000,9 @@ class ToolRouter(Resource, t.Generic[TTool, TToolCollection]):"""Retrieve and use an existing tool router session, optionally attaching custom tools.- When ``custom_tools`` or ``custom_toolkits`` are provided, the SDK- attaches them to the session so they are available for search and- execution. Without customs it simply rehydrates the existing session.+ The SDK always attaches to the session endpoint. When ``custom_tools``+ or ``custom_toolkits`` are provided, they are included so they are+ available for search and execution.:param session_id: The session ID to retrieve:param custom_tools: Optional custom tools to attach to the session.@@ -1046,15 +1046,18 @@ class ToolRouter(Resource, t.Generic[TTool, TToolCollection]):serialize_custom_toolkits(custom_toolkits))- from urllib.parse import quote+ from urllib.parse import quote- session = self._client.post(- f"/api/v3.1/tool_router/session/{quote(session_id, safe='')}/attach",- body={"experimental": inline_custom_tools_payload},- cast_to=SessionRetrieveResponse,- )- else:- session = self._client.tool_router.session.retrieve(session_id)+ body = (+ {"experimental": inline_custom_tools_payload}+ if inline_custom_tools_payload is not None+ else {}+ )+ session = self._client.post(+ f"/api/v3.1/tool_router/session/{quote(session_id, safe='')}/attach",+ body=body,+ cast_to=SessionRetrieveResponse,+ )custom_tools_map: t.Optional[CustomToolsMap] = Noneuser_id: t.Optional[str] = Nonediff --git a/python/tests/test_tool_router.py b/python/tests/test_tool_router.pyindex a5cc06891..e23480131 100644--- a/python/tests/test_tool_router.py+++ b/python/tests/test_tool_router.py@@ -5,6 +5,9 @@ from unittest.mock import MagicMock, patchimport pytestfrom composio_client import omitfrom pydantic import BaseModel, Field+from composio_client.types.tool_router.session_retrieve_response import (+ SessionRetrieveResponse,+)from composio.exceptions import ValidationErrorfrom composio.core.models.custom_tool import ExperimentalAPI@@ -56,6 +59,7 @@ def mock_client():client.tool_router.session.create.return_value = mock_session_responseclient.tool_router.session.retrieve.return_value = mock_session_response+ client.post.return_value = mock_session_response# Mock link responsemock_link_response = MagicMock()@@ -933,10 +937,8 @@ class TestToolRouter:tool_router.use(session_id="session_123")def test_use_session(self, tool_router, mock_client):- """Test retrieving an existing session."""- mock_client.tool_router.session.retrieve.return_value.config.preload.tools = [- "GMAIL_FETCH_EMAILS"- ]+ """Test attaching an existing session."""+ mock_client.post.return_value.config.preload.tools = ["GMAIL_FETCH_EMAILS"]session = tool_router.use(session_id="session_123")@@ -957,21 +959,63 @@ class TestToolRouter:assert callable(session.toolkits)assert session.preload.tools == ["GMAIL_FETCH_EMAILS"]- # Verify retrieve was called- mock_client.tool_router.session.retrieve.assert_called_once_with("session_123")+ mock_client.post.assert_called_once_with(+ "/api/v3.1/tool_router/session/session_123/attach",+ body={},+ cast_to=SessionRetrieveResponse,+ )+ mock_client.tool_router.session.retrieve.assert_not_called()++ def test_use_session_with_custom_tools(self, tool_router, mock_client):+ """Test attaching custom tools when reusing a session."""++ @experimental_api.tool(+ slug="GREP",+ name="Grep",+ description="Search local text",+ )+ def grep(input: GrepInput, ctx):+ return {"matches": []}++ mock_response = mock_client.post.return_value+ mock_response.experimental = MagicMock()+ mock_response.experimental.assistive_prompt = None+ mock_response.experimental.custom_toolkits = []+ mock_custom_tool = MagicMock()+ mock_custom_tool.slug = "SERVER_GREP"+ mock_custom_tool.original_slug = "GREP"+ mock_custom_tool.extends_toolkit = None+ mock_response.experimental.custom_tools = [mock_custom_tool]++ session = tool_router.use(session_id="session_123", custom_tools=[grep])++ mock_client.post.assert_called_once()+ assert mock_client.post.call_args.args[0] == (+ "/api/v3.1/tool_router/session/session_123/attach"+ )+ kwargs = mock_client.post.call_args.kwargs+ assert kwargs["cast_to"] is SessionRetrieveResponse+ assert kwargs["body"]["experimental"]["custom_tools"][0]["slug"] == "GREP"+ assert "custom_toolkits" not in kwargs["body"]["experimental"]+ mock_client.tool_router.session.retrieve.assert_not_called()+ assert session.custom_tools()[0].slug == "SERVER_GREP"+ assert session.custom_tools()[0].name == "Grep"def test_use_session_with_different_user(self, tool_router, mock_client):"""Test that use() extracts user_id from session config."""- mock_retrieve_response = MagicMock()- mock_retrieve_response.session_id = "session_456"- mock_retrieve_response.mcp = MagicMock()- mock_retrieve_response.mcp.type = "http"- mock_retrieve_response.mcp.url = "https://mcp.example.com/session_456"- mock_retrieve_response.tool_router_tools = ["TOOL_1"]- mock_retrieve_response.config = MagicMock()- mock_retrieve_response.config.user_id = "custom_user_789"-- mock_client.tool_router.session.retrieve.return_value = mock_retrieve_response+ mock_attach_response = MagicMock()+ mock_attach_response.session_id = "session_456"+ mock_attach_response.mcp = MagicMock()+ mock_attach_response.mcp.type = "http"+ mock_attach_response.mcp.url = "https://mcp.example.com/session_456"+ mock_attach_response.tool_router_tools = ["TOOL_1"]+ mock_attach_response.config = MagicMock()+ mock_attach_response.config.user_id = "custom_user_789"+ mock_attach_response.config.preload = MagicMock()+ mock_attach_response.config.preload.tools = []+ mock_attach_response.experimental = None++ mock_client.post.return_value = mock_attach_responsesession = tool_router.use(session_id="session_456")@@ -979,10 +1023,8 @@ class TestToolRouter:assert session.mcp.type == ToolRouterMCPServerType.HTTPdef test_use_session_throws_error_on_failure(self, tool_router, mock_client):- """Test that use() throws error if retrieve fails."""- mock_client.tool_router.session.retrieve.side_effect = Exception(- "Session not found"- )+ """Test that use() throws error if attach fails."""+ mock_client.post.side_effect = Exception("Session not found")with pytest.raises(Exception, match="Session not found"):tool_router.use(session_id="invalid_session")@@ -1376,7 +1418,7 @@ class TestToolRouter:def test_use_vs_create_independence(self, tool_router, mock_client):"""Test that use() and create() are independent."""- # Setup different responses for create and retrieve+ # Setup different responses for create and attachmock_create_response = MagicMock()mock_create_response.session_id = "created_session"mock_create_response.mcp = MagicMock()@@ -1384,17 +1426,20 @@ class TestToolRouter:mock_create_response.mcp.url = "https://mcp.example.com/created"mock_create_response.tool_router_tools = ["TOOL_1"]- mock_retrieve_response = MagicMock()- mock_retrieve_response.session_id = "retrieved_session"- mock_retrieve_response.mcp = MagicMock()- mock_retrieve_response.mcp.type = "http"- mock_retrieve_response.mcp.url = "https://mcp.example.com/retrieved"- mock_retrieve_response.tool_router_tools = ["TOOL_2"]- mock_retrieve_response.config = MagicMock()- mock_retrieve_response.config.user_id = "user_456"+ mock_attach_response = MagicMock()+ mock_attach_response.session_id = "retrieved_session"+ mock_attach_response.mcp = MagicMock()+ mock_attach_response.mcp.type = "http"+ mock_attach_response.mcp.url = "https://mcp.example.com/retrieved"+ mock_attach_response.tool_router_tools = ["TOOL_2"]+ mock_attach_response.config = MagicMock()+ mock_attach_response.config.user_id = "user_456"+ mock_attach_response.config.preload = MagicMock()+ mock_attach_response.config.preload.tools = []+ mock_attach_response.experimental = Nonemock_client.tool_router.session.create.return_value = mock_create_response- mock_client.tool_router.session.retrieve.return_value = mock_retrieve_response+ mock_client.post.return_value = mock_attach_response# Create a new sessioncreated_session = tool_router.create(user_id="user_123")@@ -1406,7 +1451,12 @@ class TestToolRouter:# Verify both methods were calledmock_client.tool_router.session.create.assert_called_once()- mock_client.tool_router.session.retrieve.assert_called_once()+ mock_client.post.assert_called_once_with(+ "/api/v3.1/tool_router/session/retrieved_session/attach",+ body={},+ cast_to=SessionRetrieveResponse,+ )+ mock_client.tool_router.session.retrieve.assert_not_called()class TestToolRouterTypes:@@ -1755,13 +1805,13 @@ class TestToolRouterIntegration:assert tools == ["tool1", "tool2"]def test_create_and_use_same_session(self, tool_router, mock_client):- """Test creating a session and then retrieving it."""+ """Test creating a session and then attaching it."""# Create sessioncreated_session = tool_router.create(user_id="user_123")created_session_id = created_session.session_id- # Setup retrieve to return the same session- mock_client.tool_router.session.retrieve.return_value = (+ # Setup attach to return the same session+ mock_client.post.return_value = (mock_client.tool_router.session.create.return_value)