Skip to content

feat(mcp): handle ToolContext in MCP tool callbacks #2432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 11, 2025
Merged

feat(mcp): handle ToolContext in MCP tool callbacks #2432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions mcp/common/src/main/java/org/springframework/ai/mcp/AsyncMcpToolCallback.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import io.modelcontextprotocol.spec.McpSchema.CallToolRequest;
import io.modelcontextprotocol.spec.McpSchema.Tool;

import org.springframework.ai.chat.model.ToolContext;
import org.springframework.ai.model.ModelOptionsUtils;
import org.springframework.ai.tool.ToolCallback;
import org.springframework.ai.tool.definition.ToolDefinition;
Expand Down Expand Up @@ -110,4 +111,10 @@ public String call(String functionInput) {
.block();
}

@Override
public String call(String toolArguments, ToolContext toolContext) {
// ToolContext is not supported by the MCP tools
return this.call(toolArguments);
}

}
7 changes: 7 additions & 0 deletions mcp/common/src/main/java/org/springframework/ai/mcp/SyncMcpToolCallback.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
import io.modelcontextprotocol.spec.McpSchema.CallToolResult;
import io.modelcontextprotocol.spec.McpSchema.Tool;

import org.springframework.ai.chat.model.ToolContext;
import org.springframework.ai.model.ModelOptionsUtils;
import org.springframework.ai.tool.ToolCallback;
import org.springframework.ai.tool.definition.ToolDefinition;
Expand Down Expand Up @@ -111,4 +112,10 @@ public String call(String functionInput) {
return ModelOptionsUtils.toJsonString(response.content());
}

@Override
public String call(String toolArguments, ToolContext toolContext) {
Copy link
Member

@ilayaperumalg ilayaperumalg Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to understand why the default implementation of call(String, ToolContext) at ToolCallback is not enough as it handles null check and call(String) eventually.

Copy link
Contributor Author

@tzolov tzolov Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The default implementation doesn't support non-empty ToolContext parameters and throws an exception. Here we override this to just ignore the tool-context parameter as it doesn't make sense for MCP

// ToolContext is not supported by the MCP tools
return this.call(toolArguments);
}

}
20 changes: 20 additions & 0 deletions mcp/common/src/test/java/org/springframework/ai/mcp/SyncMcpToolCallbackTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@

package org.springframework.ai.mcp;

import java.util.Map;

import io.modelcontextprotocol.client.McpSyncClient;
import io.modelcontextprotocol.spec.McpSchema.CallToolRequest;
import io.modelcontextprotocol.spec.McpSchema.CallToolResult;
Expand All @@ -25,6 +27,8 @@
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import org.springframework.ai.chat.model.ToolContext;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.mock;
Expand Down Expand Up @@ -71,4 +75,20 @@ void callShouldHandleJsonInputAndOutput() {
assertThat(response).isNotNull();
}

@Test
void callShoulIngroeToolContext() {
// Arrange
when(tool.name()).thenReturn("testTool");
CallToolResult callResult = mock(CallToolResult.class);
when(mcpClient.callTool(any(CallToolRequest.class))).thenReturn(callResult);

SyncMcpToolCallback callback = new SyncMcpToolCallback(mcpClient, tool);

// Act
String response = callback.call("{\"param\":\"value\"}", new ToolContext(Map.of("foo", "bar")));

// Assert
assertThat(response).isNotNull();
}

}