org.noear.solon.ai.mcp.client

Class McpClientProvider

java.lang.Object

org.noear.solon.ai.mcp.client.McpClientProvider

All Implemented Interfaces:

Closeable, AutoCloseable, ToolProvider, PromptProvider, ResourceProvider

public class McpClientProvider
extends Object
implements ToolProvider, ResourceProvider, PromptProvider, Closeable

Mcp 客户端提供者

 McpClientProvider toolProvider = McpClientProvider.builder()
                 .apiUrl("http://localhost:8081/sse")
                 .build();

 ChatModel chatModel = ChatModel.of("http://127.0.0.1:11434/api/chat")
                 .model("deepseek-v3")
                 .defaultToolsAdd(toolProvider)
                 .build();

 ChatResponse resp = chatModel.prompt("杭州天气和北京降雨量如何？")
                 .call();
 

Since:

3.1

Author:

noear

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	McpClientProvider.Builder

Constructor Summary

Constructors

Constructor and Description
McpClientProvider(McpClientProperties clientProps)
McpClientProvider(Properties clientProps) 用于支持注入
McpClientProvider(String apiUrl) 用于简单构建

Method Summary

Modifier and Type	Method and Description
static McpClientProvider.Builder	builder()
McpSchema.CallToolResult	callTool(String name, Map<String,Object> args) 调用工具
Image	callToolAsImage(String name, Map<String,Object> args) 调用工具并转为图像
Text	callToolAsText(String name, Map<String,Object> args) 调用工具并转为文本
void	clearCache() 清理缓存
void	close() 关闭
static Map<String,McpClientProvider>	fromMcpServers(String uri) Deprecated. 3.3 McpProviders.fromMcpServers(String)
McpAsyncClient	getClient() 获取客户端
McpSchema.GetPromptResult	getPrompt(String name, Map<String,Object> args) 获取提示语
List<ChatMessage>	getPromptAsMessages(String name, Map<String,Object> args) 获取提示语
Collection<FunctionPrompt>	getPrompts() 获取提示语
Collection<FunctionPrompt>	getPrompts(String cursor)
Collection<FunctionResource>	getResources() 获取资源
Collection<FunctionResource>	getResources(String cursor)
Collection<FunctionResource>	getResourceTemplates()
Collection<FunctionResource>	getResourceTemplates(String cursor)
Collection<FunctionTool>	getTools() 获取函数工具（可用于模型绑定）
Collection<FunctionTool>	getTools(String cursor) 获取函数工具（可用于模型绑定）
McpSchema.ReadResourceResult	readResource(String uri) 读取资源
Text	readResourceAsText(String uri) 读取资源
void	reopen() 重新打开
void	setLoggingLevel(McpSchema.LoggingLevel loggingLevel) 设置日志级别

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

McpClientProvider

public McpClientProvider(Properties clientProps)

用于支持注入

McpClientProvider

public McpClientProvider(String apiUrl)

用于简单构建

McpClientProvider

public McpClientProvider(McpClientProperties clientProps)

Method Detail

clearCache

public void clearCache()

清理缓存

getClient

public McpAsyncClient getClient()

获取客户端

setLoggingLevel

public void setLoggingLevel(McpSchema.LoggingLevel loggingLevel)

设置日志级别

close

public void close()

关闭

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

reopen

public void reopen()

重新打开

callToolAsText

public Text callToolAsText(String name,
                           Map<String,Object> args)

调用工具并转为文本

Parameters:

name - 工具名

args - 调用参数

callToolAsImage

public Image callToolAsImage(String name,
                             Map<String,Object> args)

调用工具并转为图像

Parameters:

name - 工具名

args - 调用参数

callTool

public McpSchema.CallToolResult callTool(String name,
                                         Map<String,Object> args)

调用工具

Parameters:

name - 工具名

args - 调用参数

readResourceAsText

public Text readResourceAsText(String uri)

读取资源

Parameters:

uri - 资源地址

readResource

public McpSchema.ReadResourceResult readResource(String uri)

读取资源

Parameters:

uri - 资源地址

getPromptAsMessages

public List<ChatMessage> getPromptAsMessages(String name,
                                             Map<String,Object> args)

获取提示语

Parameters:

name - 名字

args - 参数

getPrompt

public McpSchema.GetPromptResult getPrompt(String name,
                                           Map<String,Object> args)

获取提示语

Parameters:

name - 名字

args - 参数

getTools

public Collection<FunctionTool> getTools()

获取函数工具（可用于模型绑定）

Specified by:

getTools in interface ToolProvider

getTools

public Collection<FunctionTool> getTools(String cursor)

获取函数工具（可用于模型绑定）

Parameters:

cursor - 游标

getResources

public Collection<FunctionResource> getResources()

Description copied from interface: ResourceProvider

获取资源

Specified by:

getResources in interface ResourceProvider

getResources

public Collection<FunctionResource> getResources(String cursor)

getResourceTemplates

public Collection<FunctionResource> getResourceTemplates()

getResourceTemplates

public Collection<FunctionResource> getResourceTemplates(String cursor)

getPrompts

public Collection<FunctionPrompt> getPrompts()

Description copied from interface: PromptProvider

获取提示语

Specified by:

getPrompts in interface PromptProvider

getPrompts

public Collection<FunctionPrompt> getPrompts(String cursor)

fromMcpServers

@Deprecated
public static Map<String,McpClientProvider> fromMcpServers(String uri)
                                                                throws IOException

Deprecated. 3.3 McpProviders.fromMcpServers(String)

根据 mcpServers 配置加载客户端

Parameters:

uri - 配置资源地址

Throws:

IOException

builder

public static McpClientProvider.Builder builder()