org.noear.solon.ai.mcp.client

类 McpClientProvider

java.lang.Object

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

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, ToolProvider, PromptProvider, ResourceProvider

public class McpClientProvider
extends java.lang.Object
implements ToolProvider, ResourceProvider, PromptProvider, java.io.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();
 

从以下版本开始:

3.1

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	McpClientProvider.Builder

构造器概要

构造器

构造器和说明
McpClientProvider(McpClientProperties clientProps)
McpClientProvider(java.util.Properties clientProps) 用于支持注入
McpClientProvider(java.lang.String apiUrl) 用于简单构建

方法概要

限定符和类型	方法和说明
static McpClientProvider.Builder	builder()
McpSchema.CallToolResult	callTool(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> args) 调用工具
Image	callToolAsImage(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> args) 调用工具并转为图像
Text	callToolAsText(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> args) 调用工具并转为文本
void	close() 关闭
static java.util.Map<java.lang.String,McpClientProvider>	fromMcpServers(java.lang.String uri) 根据 mcpServers 配置加载客户端
McpSyncClient	getClient() 获取客户端
McpSchema.GetPromptResult	getPrompt(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> args) 获取提示语
java.util.List<ChatMessage>	getPromptAsMessages(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> args) 获取提示语
java.util.Collection<FunctionPrompt>	getPrompts() 获取提示语
java.util.Collection<FunctionPrompt>	getPrompts(java.lang.String cursor)
java.util.Collection<FunctionResource>	getResources() 获取资源
java.util.Collection<FunctionResource>	getResources(java.lang.String cursor)
java.util.Collection<FunctionResource>	getResourceTemplates()
java.util.Collection<FunctionResource>	getResourceTemplates(java.lang.String cursor)
java.util.Collection<FunctionTool>	getTools() 获取函数工具（可用于模型绑定）
java.util.Collection<FunctionTool>	getTools(java.lang.String cursor) 获取函数工具（可用于模型绑定）
McpSchema.ReadResourceResult	readResource(java.lang.String uri) 读取资源
Text	readResourceAsText(java.lang.String uri) 读取资源
void	reopen() 重新打开
void	setLoggingLevel(McpSchema.LoggingLevel loggingLevel) 设置日志级别

从类继承的方法 java.lang.Object

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

构造器详细资料

McpClientProvider

public McpClientProvider(java.util.Properties clientProps)

用于支持注入

McpClientProvider

public McpClientProvider(java.lang.String apiUrl)

用于简单构建

McpClientProvider

public McpClientProvider(McpClientProperties clientProps)

方法详细资料

getClient

public McpSyncClient getClient()

获取客户端

setLoggingLevel

public void setLoggingLevel(McpSchema.LoggingLevel loggingLevel)

设置日志级别

close

public void close()

关闭

指定者:

close 在接口中 java.io.Closeable

指定者:

close 在接口中 java.lang.AutoCloseable

reopen

public void reopen()

重新打开

callToolAsText

public Text callToolAsText(java.lang.String name,
                           java.util.Map<java.lang.String,java.lang.Object> args)

调用工具并转为文本

参数:

name - 工具名

args - 调用参数

callToolAsImage

public Image callToolAsImage(java.lang.String name,
                             java.util.Map<java.lang.String,java.lang.Object> args)

调用工具并转为图像

参数:

name - 工具名

args - 调用参数

callTool

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

调用工具

参数:

name - 工具名

args - 调用参数

readResourceAsText

public Text readResourceAsText(java.lang.String uri)

读取资源

参数:

uri - 资源地址

readResource

public McpSchema.ReadResourceResult readResource(java.lang.String uri)

读取资源

参数:

uri - 资源地址

getPromptAsMessages

public java.util.List<ChatMessage> getPromptAsMessages(java.lang.String name,
                                                       java.util.Map<java.lang.String,java.lang.Object> args)

获取提示语

参数:

name - 名字

args - 参数

getPrompt

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

获取提示语

参数:

name - 名字

args - 参数

getTools

public java.util.Collection<FunctionTool> getTools()

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

指定者:

getTools 在接口中 ToolProvider

getTools

public java.util.Collection<FunctionTool> getTools(java.lang.String cursor)

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

参数:

cursor - 游标

getResources

public java.util.Collection<FunctionResource> getResources()

从接口复制的说明: ResourceProvider

获取资源

指定者:

getResources 在接口中 ResourceProvider

getResources

public java.util.Collection<FunctionResource> getResources(java.lang.String cursor)

getResourceTemplates

public java.util.Collection<FunctionResource> getResourceTemplates()

getResourceTemplates

public java.util.Collection<FunctionResource> getResourceTemplates(java.lang.String cursor)

getPrompts

public java.util.Collection<FunctionPrompt> getPrompts()

从接口复制的说明: PromptProvider

获取提示语

指定者:

getPrompts 在接口中 PromptProvider

getPrompts

public java.util.Collection<FunctionPrompt> getPrompts(java.lang.String cursor)

fromMcpServers

public static java.util.Map<java.lang.String,McpClientProvider> fromMcpServers(java.lang.String uri)
                                                                        throws java.io.IOException

根据 mcpServers 配置加载客户端

参数:

uri - 配置资源地址

抛出:

java.io.IOException

builder

public static McpClientProvider.Builder builder()