Refactor associated_tools structure to include name and displayName attributes

Signed-off-by: Arjav <[email protected]>

Author: arjavdongaonkar

tests/integration/test_integration.py

@@ -108,6 +108,7 @@ def auth_headers() -> dict[str, str]:
     id="tool-1",
     name="test_tool",
     original_name="test_tool",
+    displayName="Test Tool",
     url="http://example.com/tools/test",
     description="demo",
     request_type="POST",
@@ -138,7 +139,13 @@ def auth_headers() -> dict[str, str]:
     created_at=datetime(2025, 1, 1),
     updated_at=datetime(2025, 1, 1),
     is_active=True,
-    associated_tools=[MOCK_TOOL.id],
+    associated_tools=[
+        {
+            "id": MOCK_TOOL.id,
+            "name": MOCK_TOOL.name,
+            "displayName": MOCK_TOOL.displayName,
+        }
+    ],
     associated_resources=[],
     associated_prompts=[],
     metrics=MOCK_METRICS,
@@ -194,7 +201,7 @@ def test_server_with_tools_workflow(
         srv_req = {
             "name": "test_server",
             "description": "integration server",
-            "associated_tools": [MOCK_TOOL.id],
+            "associated_tools": [{"id": MOCK_TOOL.id, "name": MOCK_TOOL.name, "displayName": MOCK_TOOL.displayName}],
         }
         resp_srv = test_client.post("/servers/", json=srv_req, headers=auth_headers)
         assert resp_srv.status_code == 201

tests/unit/mcpgateway/services/test_server_service.py

@@ -173,7 +173,7 @@ def capture_add(server):
                 created_at="2023-01-01T00:00:00",
                 updated_at="2023-01-01T00:00:00",
                 is_active=True,
-                associated_tools=["101"],
+                associated_tools=[{"id": "101", "name": "test_tool", "displayName": "Test Tool"}],
                 associated_resources=[201],
                 associated_prompts=[301],
                 metrics={
@@ -208,7 +208,7 @@ def capture_add(server):
         server_service._notify_server_added.assert_called_once()
 
         assert result.name == "test_server"
-        assert "101" in result.associated_tools
+        assert [{'displayName': 'Test Tool', 'id': '101', 'name': 'test_tool'}] == result.associated_tools
         assert 201 in result.associated_resources
         assert 301 in result.associated_prompts
 
@@ -278,7 +278,7 @@ async def test_list_servers(self, server_service, mock_server, test_db):
             created_at="2023-01-01T00:00:00",
             updated_at="2023-01-01T00:00:00",
             is_active=True,
-            associated_tools=["101"],
+            associated_tools=[{"id": "101", "name": "test_tool", "displayName": "Test Tool"}],
             associated_resources=[201],
             associated_prompts=[301],
             metrics={
@@ -312,7 +312,7 @@ async def test_get_server(self, server_service, mock_server, test_db):
             created_at="2023-01-01T00:00:00",
             updated_at="2023-01-01T00:00:00",
             is_active=True,
-            associated_tools=["101"],
+            associated_tools=[{"id": "101", "name": "test_tool", "displayName": "Test Tool"}],
             associated_resources=[201],
             associated_prompts=[301],
             metrics={
@@ -409,7 +409,7 @@ async def test_update_server(self, server_service, mock_server, test_db, mock_to
                 created_at="2023-01-01T00:00:00",
                 updated_at="2023-01-01T00:00:00",
                 is_active=True,
-                associated_tools=["102"],
+                associated_tools=[{"id": "102", "name": "new_tool", "displayName": "New Tool"}],
                 associated_resources=[202],
                 associated_prompts=[302],
                 metrics={
@@ -489,7 +489,7 @@ async def test_toggle_server_status(self, server_service, mock_server, test_db):
                 created_at="2023-01-01T00:00:00",
                 updated_at="2023-01-01T00:00:00",
                 is_active=False,
-                associated_tools=["101"],
+                associated_tools=[{"id": "101", "name": "test_tool", "displayName": "Test Tool"}],
                 associated_resources=[201],
                 associated_prompts=[301],
                 metrics={

tests/unit/mcpgateway/test_main.py

@@ -55,7 +55,7 @@
     "created_at": "2023-01-01T00:00:00+00:00",
     "updated_at": "2023-01-01T00:00:00+00:00",
     "is_active": True,
-    "associated_tools": ["101"],
+    "associated_tools": [{"id": "101", "name": "test_tool", "displayName": "Test Tool"}],
     "associated_resources": [201],
     "associated_prompts": [301],
     "metrics": MOCK_METRICS,

tests/unit/mcpgateway/test_schemas.py

@@ -756,7 +756,9 @@ def test_server_read(self):
             created_at=one_hour_ago,
             updated_at=now,
             is_active=True,
-            associated_tools=["1", "2", "3"],
+            associated_tools=[{"id": "1", "name": "tool_1", "displayName": "Tool 1"},
+                              {"id": "2", "name": "tool_2", "displayName": "Tool 2"},
+                              {"id": "3", "name": "tool_3", "displayName": "Tool 3"}],
             associated_resources=[4, 5],
             associated_prompts=[6],
             metrics=ServerMetrics(
@@ -778,7 +780,9 @@ def test_server_read(self):
         assert server.created_at == one_hour_ago
         assert server.updated_at == now
         assert server.is_active is True
-        assert server.associated_tools == ["1", "2", "3"]
+        assert server.associated_tools == [{"id": "1", "name": "tool_1", "displayName": "Tool 1"},
+                                           {"id": "2", "name": "tool_2", "displayName": "Tool 2"},
+                                           {"id": "3", "name": "tool_3", "displayName": "Tool 3"}]
         assert server.associated_resources == [4, 5]
         assert server.associated_prompts == [6]
         assert server.metrics.total_executions == 100
@@ -793,7 +797,10 @@ def test_server_read(self):
             created_at=one_hour_ago,
             updated_at=now,
             is_active=True,
-            associated_tools=[Mock(id="10"), Mock(id="11")],
+            associated_tools=[
+                {"id": "10", "name": "test_tool", "displayName": "Test Tool"},
+                {"id": "11", "name": "test_tool_1", "displayName": "Test Tool 1"},
+            ],
             associated_resources=[Mock(id=12)],
             associated_prompts=[Mock(id=13)],
             metrics=ServerMetrics(
@@ -804,7 +811,10 @@ def test_server_read(self):
             ),
         )
 
-        assert server_with_objects.associated_tools == ["10", "11"]
+        assert server_with_objects.associated_tools == [
+            {"id": "10", "name": "test_tool", "displayName": "Test Tool"},
+            {"id": "11", "name": "test_tool_1", "displayName": "Test Tool 1"},
+        ]
         assert server_with_objects.associated_resources == [12]
         assert server_with_objects.associated_prompts == [13]