54
ToolRouterSessionWithMcp,
55
)
56
from composio.exceptions import (
57
+ ComposioDeprecationWarning,
58
InvalidParams,
59
MCPDestinationError,
60
SessionConfigConflictError,
893
tool_router.create(
894
user_id="user_123",
895
preload={"tools": ["GREP"]},
895
- experimental={"custom_tools": [grep]},
896
+ experimental={"local_tools": [grep]},
897
)
898
899
mock_client.tool_router.session.create.assert_not_called()
985
session_preset=SESSION_PRESET_DIRECT_TOOLS,
986
toolkits=["github"],
987
preload={"tools": ["GITHUB_CREATE_ISSUE"]},
987
- experimental={"custom_tools": [grep]},
988
+ experimental={"local_tools": [grep]},
989
)
990
991
kwargs = mock_client.tool_router.session.create.call_args.kwargs
1279
mock_custom_tool.extends_toolkit = None
1280
mock_response.experimental.custom_tools = [mock_custom_tool]
1281
1281
- session = tool_router.use(session_id="session_123", custom_tools=[grep])
1282
+ session = tool_router.use(session_id="session_123", local_tools=[grep])
1283
1284
mock_client.tool_router.session.attach.assert_called_once()
1285
kwargs = mock_client.tool_router.session.attach.call_args.kwargs
1287
assert "custom_toolkits" not in kwargs["experimental"]
1288
mock_client.tool_router.session.retrieve.assert_not_called()
1289
mock_client.post.assert_not_called()
1289
- assert session.custom_tools()[0].slug == "SERVER_GREP"
1290
- assert session.custom_tools()[0].name == "Grep"
1290
+ assert session.local_tools()[0].slug == "SERVER_GREP"
1291
+ assert session.local_tools()[0].name == "Grep"
1292
1293
@patch("composio.core.models.tools.Tools")
1294
def test_use_session_attaches_preloaded_custom_tools(
1331
mock_tools_class.return_value = mock_tools_instance
1332
mock_provider.wrap_tools.return_value = "mocked-custom-tools"
1333
1333
- session = tool_router.use(session_id="session_123", custom_tools=[grep])
1334
+ session = tool_router.use(session_id="session_123", local_tools=[grep])
1335
session.tools()
1336
1337
mock_client.tool_router.session.attach.assert_called_once()
1387
mock_tools_class.return_value = mock_tools_instance
1388
mock_provider.wrap_tools.return_value = "mocked-custom-tools"
1389
1389
- session = tool_router.use(session_id="session_123", custom_tools=[grep])
1390
+ session = tool_router.use(session_id="session_123", local_tools=[grep])
1391
session.tools()
1392
session.search(query="search local text")
1393
1735
1736
session = tool_router.create(
1737
user_id="user_123",
1737
- experimental={"custom_tools": [grep]},
1738
+ experimental={"local_tools": [grep]},
1739
)
1740
result = session.tools()
1741
1904
mock_client.post.assert_not_called()
1905
1906
1907
+def _local_grep_tool():
1908
+ @experimental_api.tool(slug="GREP", name="Grep", description="Search local text")
1909
+ def grep(input: GrepInput, ctx):
1910
+ return {"matches": []}
1911
+
1912
+ return grep
1913
+
1914
+
1915
+def _local_role_toolkit():
1916
+ toolkit = experimental_api.Toolkit(
1917
+ slug="ROLES", name="Roles", description="Manage roles"
1918
+ )
1919
+
1920
+ @toolkit.tool(slug="SET_ROLE")
1921
+ def set_role(input: GrepInput, ctx):
1922
+ """Set a role."""
1923
+ return {"ok": True}
1924
+
1925
+ return toolkit
1926
+
1927
+
1928
+def _mock_local_tools_response(response):
1929
+ response.experimental = MagicMock()
1930
+ response.experimental.assistive_prompt = None
1931
+ server_tool = MagicMock()
1932
+ server_tool.slug = "LOCAL_GREP"
1933
+ server_tool.original_slug = "GREP"
1934
+ server_tool.extends_toolkit = None
1935
+ response.experimental.custom_tools = [server_tool]
1936
+ server_toolkit = MagicMock()
1937
+ server_toolkit.slug = "ROLES"
1938
+ server_toolkit.tools = [
1939
+ MagicMock(slug="LOCAL_ROLES_SET_ROLE", original_slug="SET_ROLE")
1940
+ ]
1941
+ response.experimental.custom_toolkits = [server_toolkit]
1942
+
1943
+
1944
+class TestLocalToolsOptions:
1945
+ """`local_tools`/`local_toolkits` and their deprecated `custom_*` aliases."""
1946
+
1947
+ def test_create_with_local_tools_sends_custom_wire_fields(
1948
+ self, tool_router, mock_client
1949
+ ):
1950
+ _mock_local_tools_response(mock_client.tool_router.session.create.return_value)
1951
+ tool = _local_grep_tool()
1952
+ toolkit = _local_role_toolkit()
1953
+
1954
+ with warnings.catch_warnings():
1955
+ warnings.simplefilter("error")
1956
+ session = tool_router.create(
1957
+ user_id="user_123",
1958
+ experimental={
1959
+ "local_tools": [tool],
1960
+ "local_toolkits": [toolkit],
1961
+ },
1962
+ )
1963
+
1964
+ experimental = mock_client.tool_router.session.create.call_args.kwargs[
1965
+ "experimental"
1966
+ ]
1967
+ assert set(experimental) == {"custom_tools", "custom_toolkits"}
1968
+ assert experimental["custom_tools"][0]["slug"] == "GREP"
1969
+ assert experimental["custom_toolkits"][0]["slug"] == "ROLES"
1970
+ assert [tool.slug for tool in session.local_tools()] == [
1971
+ "LOCAL_GREP",
1972
+ "LOCAL_ROLES_SET_ROLE",
1973
+ ]
1974
+ assert [tk.slug for tk in session.local_toolkits()] == ["ROLES"]
1975
+
1976
+ def test_create_with_deprecated_custom_names_warns(self, tool_router, mock_client):
1977
+ _mock_local_tools_response(mock_client.tool_router.session.create.return_value)
1978
+ tool = _local_grep_tool()
1979
+ toolkit = _local_role_toolkit()
1980
+
1981
+ with pytest.warns(ComposioDeprecationWarning) as record:
1982
+ session = tool_router.create(
1983
+ user_id="user_123",
1984
+ experimental={
1985
+ "custom_tools": [tool],
1986
+ "custom_toolkits": [toolkit],
1987
+ },
1988
+ )
1989
+
1990
+ assert [str(w.message) for w in record] == [
1991
+ "`custom_tools` is deprecated; use `local_tools`",
1992
+ "`custom_toolkits` is deprecated; use `local_toolkits`",
1993
+ ]
1994
+ assert record[0].filename == __file__
1995
+ experimental = mock_client.tool_router.session.create.call_args.kwargs[
1996
+ "experimental"
1997
+ ]
1998
+ assert experimental["custom_tools"][0]["slug"] == "GREP"
1999
+ assert experimental["custom_toolkits"][0]["slug"] == "ROLES"
2000
+ assert session.local_tools()[0].slug == "LOCAL_GREP"
2001
+
2002
+ @pytest.mark.parametrize(
2003
+ ("new_name", "old_name", "value"),
2004
+ [
2005
+ ("local_tools", "custom_tools", _local_grep_tool),
2006
+ ("local_toolkits", "custom_toolkits", _local_role_toolkit),
2007
+ ],
2008
+ )
2009
+ def test_create_rejects_new_and_deprecated_names_together(
2010
+ self, tool_router, mock_client, new_name, old_name, value
2011
+ ):
2012
+ with pytest.raises(
2013
+ InvalidParams,
2014
+ match=f"^Pass either `{new_name}` or `{old_name}`, not both",
2015
+ ):
2016
+ tool_router.create(
2017
+ user_id="user_123",
2018
+ experimental=t.cast(
2019
+ ToolRouterExperimentalConfig,
2020
+ {new_name: [value()], old_name: [value()]},
2021
+ ),
2022
+ )
2023
+
2024
+ mock_client.tool_router.session.create.assert_not_called()
2025
+
2026
+ def test_use_with_local_tools_sends_custom_wire_fields(
2027
+ self, tool_router, mock_client
2028
+ ):
2029
+ _mock_local_tools_response(mock_client.tool_router.session.attach.return_value)
2030
+ tool = _local_grep_tool()
2031
+ toolkit = _local_role_toolkit()
2032
+
2033
+ with warnings.catch_warnings():
2034
+ warnings.simplefilter("error")
2035
+ session = tool_router.use(
2036
+ "session_123",
2037
+ local_tools=[tool],
2038
+ local_toolkits=[toolkit],
2039
+ )
2040
+
2041
+ experimental = mock_client.tool_router.session.attach.call_args.kwargs[
2042
+ "experimental"
2043
+ ]
2044
+ assert set(experimental) == {"custom_tools", "custom_toolkits"}
2045
+ assert [tool.slug for tool in session.local_tools()] == [
2046
+ "LOCAL_GREP",
2047
+ "LOCAL_ROLES_SET_ROLE",
2048
+ ]
2049
+
2050
+ def test_use_with_deprecated_custom_names_warns(self, tool_router, mock_client):
2051
+ _mock_local_tools_response(mock_client.tool_router.session.attach.return_value)
2052
+ tool = _local_grep_tool()
2053
+ toolkit = _local_role_toolkit()
2054
+
2055
+ with pytest.warns(ComposioDeprecationWarning) as record:
2056
+ session = tool_router.use(
2057
+ "session_123",
2058
+ custom_tools=[tool],
2059
+ custom_toolkits=[toolkit],
2060
+ )
2061
+
2062
+ assert [str(w.message) for w in record] == [
2063
+ "`custom_tools` is deprecated; use `local_tools`",
2064
+ "`custom_toolkits` is deprecated; use `local_toolkits`",
2065
+ ]
2066
+ assert record[0].filename == __file__
2067
+ experimental = mock_client.tool_router.session.attach.call_args.kwargs[
2068
+ "experimental"
2069
+ ]
2070
+ assert experimental["custom_tools"][0]["slug"] == "GREP"
2071
+ assert session.local_toolkits()[0].slug == "ROLES"
2072
+
2073
+ @pytest.mark.parametrize(
2074
+ ("new_name", "old_name", "value"),
2075
+ [
2076
+ ("local_tools", "custom_tools", _local_grep_tool),
2077
+ ("local_toolkits", "custom_toolkits", _local_role_toolkit),
2078
+ ],
2079
+ )
2080
+ def test_use_rejects_new_and_deprecated_names_together(
2081
+ self, tool_router, mock_client, new_name, old_name, value
2082
+ ):
2083
+ with pytest.raises(
2084
+ InvalidParams,
2085
+ match=f"^Pass either `{new_name}` or `{old_name}`, not both",
2086
+ ):
2087
+ tool_router.use("session_123", **{new_name: [value()], old_name: [value()]})
2088
+
2089
+ mock_client.tool_router.session.attach.assert_not_called()
2090
+ mock_client.tool_router.session.retrieve.assert_not_called()
2091
+
2092
+
2093
class TestToolRouterTypes:
2094
"""Test type definitions for ToolRouter."""
2095