-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat: MCP tools support ToolContext #3831
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.
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
Open
YunKuiLu
wants to merge
1
commit into
spring-projects:main
Choose a base branch
from
YunKuiLu:tool_context_meta
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+654
−74
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
...p-client-common/src/main/resources/META-INF/additional-spring-configuration-metadata.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{"properties": [ | ||
{ | ||
"name": "spring.ai.mcp.client.toolcallback.excluded-tool-context-keys", | ||
"defaultValue": ["TOOL_CALL_HISTORY"] | ||
} | ||
]} | ||
YunKuiLu marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
114 changes: 114 additions & 0 deletions
114
mcp/common/src/main/java/org/springframework/ai/mcp/AbstractMcpToolCallback.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
/* | ||
* Copyright 2025-2025 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.ai.mcp; | ||
|
||
import java.util.HashMap; | ||
import java.util.Map; | ||
import java.util.Set; | ||
|
||
import org.springframework.ai.chat.model.ToolContext; | ||
import org.springframework.ai.tool.ToolCallback; | ||
import org.springframework.lang.Nullable; | ||
import org.springframework.util.Assert; | ||
|
||
import static io.modelcontextprotocol.spec.McpSchema.Tool; | ||
|
||
/** | ||
* Implementation of {@link ToolCallback} that adapts MCP tools to Spring AI's tool | ||
* interface with asynchronous execution support. | ||
* <p> | ||
* This class acts as a bridge between the Model Context Protocol (MCP) and Spring AI's | ||
* tool system, allowing MCP tools to be used seamlessly within Spring AI applications. | ||
* It: | ||
* <ul> | ||
* <li>Converts MCP tool definitions to Spring AI tool definitions</li> | ||
* <li>Handles the asynchronous execution of tool calls through the MCP client</li> | ||
* <li>Manages JSON serialization/deserialization of tool inputs and outputs</li> | ||
* </ul> | ||
* <p> | ||
* | ||
* @author YunKui Lu | ||
* @see ToolCallback | ||
* @see AsyncMcpToolCallback | ||
* @see SyncMcpToolCallback | ||
* @see Tool | ||
*/ | ||
public abstract class AbstractMcpToolCallback implements ToolCallback { | ||
|
||
public static final String DEFAULT_MCP_META_TOOL_CONTEXT_KEY = McpToolUtils.DEFAULT_MCP_META_TOOL_CONTEXT_KEY; | ||
|
||
protected final Tool tool; | ||
|
||
/** | ||
* the keys that will not be sent to the MCP Server inside the `_meta` field of | ||
* {@link io.modelcontextprotocol.spec.McpSchema.CallToolRequest} | ||
*/ | ||
protected final Set<String> excludedToolContextKeys; | ||
|
||
/** | ||
* Creates a new {@code AbstractMcpToolCallback} instance. | ||
* @param tool the MCP tool definition to adapt | ||
* @param excludedToolContextKeys the keys that will not be sent to the MCP Server | ||
* inside the `_meta` field of | ||
* {@link io.modelcontextprotocol.spec.McpSchema.CallToolRequest} | ||
*/ | ||
protected AbstractMcpToolCallback(Tool tool, Set<String> excludedToolContextKeys) { | ||
Assert.notNull(tool, "tool cannot be null"); | ||
Assert.notNull(excludedToolContextKeys, "excludedToolContextKeys cannot be null"); | ||
|
||
this.tool = tool; | ||
this.excludedToolContextKeys = excludedToolContextKeys; | ||
} | ||
|
||
/** | ||
* Executes the tool with the provided input. | ||
* <p> | ||
* This method: | ||
* <ol> | ||
* <li>Converts the JSON input string to a map of arguments</li> | ||
* <li>Calls the tool through the MCP client</li> | ||
* <li>Converts the tool's response content to a JSON string</li> | ||
* </ol> | ||
* @param functionInput the tool input as a JSON string | ||
* @return the tool's response as a JSON string | ||
*/ | ||
@Override | ||
public String call(String functionInput) { | ||
return this.call(functionInput, null); | ||
} | ||
|
||
/** | ||
* Converts the tool context to a mcp meta map | ||
* @param toolContext the context for tool execution in a function calling scenario | ||
* @return the mcp meta map | ||
*/ | ||
protected Map<String, Object> getAdditionalToolContextToMeta(@Nullable ToolContext toolContext) { | ||
if (toolContext == null || toolContext.getContext().isEmpty()) { | ||
return Map.of(); | ||
} | ||
|
||
Map<String, Object> meta = new HashMap<>(toolContext.getContext().size() - excludedToolContextKeys.size()); | ||
for (var toolContextEntry : toolContext.getContext().entrySet()) { | ||
if (excludedToolContextKeys.contains(toolContextEntry.getKey())) { | ||
continue; | ||
} | ||
meta.put(toolContextEntry.getKey(), toolContextEntry.getValue()); | ||
} | ||
return meta; | ||
} | ||
|
||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.