Mcp
McpToolSpec #
基类: BaseToolSpec
MCPToolSpec 将从 MCP 客户端(仅需实现 ClientSession)获取工具,并将其转换为 LlamaIndex 的 FunctionTool 对象。
参数:
名称 | 类型 | 描述 | 默认值 |
---|---|---|---|
client
|
ClientSession
|
一个实现ClientSession的MCP客户端实例,它应支持ClientSession中的以下方法: - list_tools: 列出所有工具。 - call_tool: 调用工具。 - list_resources: 列出所有资源。 - read_resource: 读取资源。 |
required |
allowed_tools
|
Optional[List[str]]
|
如果设置,仅返回具有指定名称的工具。 |
None
|
include_resources
|
bool
|
是否在工具列表中包含资源。 |
False
|
Source code in llama-index-integrations/tools/llama-index-tools-mcp/llama_index/tools/mcp/base.py
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
|
fetch_tools
async
#
fetch_tools() -> List[Any]
一个异步方法,用于从MCP客户端获取工具列表。如果设置了allowed_tools参数,将会对工具进行过滤。
返回:
类型 | 描述 |
---|---|
List[Any]
|
工具列表,每个工具对象需要包含名称、描述和输入模式属性。 |
Source code in llama-index-integrations/tools/llama-index-tools-mcp/llama_index/tools/mcp/base.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
|
fetch_resources
async
#
fetch_resources() -> List[Resource]
一个异步方法,用于从MCP客户端获取资源列表。
Source code in llama-index-integrations/tools/llama-index-tools-mcp/llama_index/tools/mcp/base.py
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
|
to_tool_list_async
async
#
to_tool_list_async() -> List[FunctionTool]
将MCP工具转换为FunctionTool对象的异步方法。
返回:
类型 | 描述 |
---|---|
List[FunctionTool]
|
FunctionTool 对象列表。 |
Source code in llama-index-integrations/tools/llama-index-tools-mcp/llama_index/tools/mcp/base.py
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
|
to_tool_list #
to_tool_list() -> List[FunctionTool]
同步接口:将MCP客户端工具转换为FunctionTool对象。 注意:此方法不应在异步环境中调用,否则会抛出异常。请改用to_tool_list_async方法。
返回:
类型 | 描述 |
---|---|
List[FunctionTool]
|
FunctionTool 对象列表。 |
Source code in llama-index-integrations/tools/llama-index-tools-mcp/llama_index/tools/mcp/base.py
188 189 190 191 192 193 194 195 196 197 |
|