tools
Tool
Bases: BaseModel
Internal tool registration info.
Source code in src/mcp/server/mcpserver/tools/base.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | |
from_function
classmethod
from_function(
fn: Callable[..., Any],
name: str | None = None,
title: str | None = None,
description: str | None = None,
context_kwarg: str | None = None,
annotations: ToolAnnotations | None = None,
icons: list[Icon] | None = None,
meta: dict[str, Any] | None = None,
structured_output: bool | None = None,
) -> Tool
Create a Tool from a function.
Source code in src/mcp/server/mcpserver/tools/base.py
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 | |
run
async
run(
arguments: dict[str, Any],
context: Context[LifespanContextT, RequestT],
convert_result: bool = False,
) -> Any
Run the tool with arguments.
Every failure other than MCPError is raised as a ToolError whose message
starts Error executing tool <name> and whose __cause__ is what was raised.
An anticipated failure keeps its own text after the prefix. A crash does not,
so nothing from an unexpected exception reaches the client.
Raises:
| Type | Description |
|---|---|
ToolError
|
If the arguments fail validation against the input schema, or
the tool function (or a resolver) raises |
UnexpectedToolError
|
If argument validation, the tool function, or a resolver raises anything else, or the return value fails output conversion. |
Source code in src/mcp/server/mcpserver/tools/base.py
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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | |
ToolManager
Manages MCPServer tools.
Source code in src/mcp/server/mcpserver/tools/tool_manager.py
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 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 | |
get_tool
Get tool by name.
Source code in src/mcp/server/mcpserver/tools/tool_manager.py
31 32 33 | |
list_tools
List all registered tools.
Source code in src/mcp/server/mcpserver/tools/tool_manager.py
35 36 37 | |
add_tool
add_tool(
fn: Callable[..., Any],
name: str | None = None,
title: str | None = None,
description: str | None = None,
annotations: ToolAnnotations | None = None,
icons: list[Icon] | None = None,
meta: dict[str, Any] | None = None,
structured_output: bool | None = None,
) -> Tool
Add a tool to the server.
Source code in src/mcp/server/mcpserver/tools/tool_manager.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 | |
remove_tool
remove_tool(name: str) -> None
Remove a tool by name.
Source code in src/mcp/server/mcpserver/tools/tool_manager.py
69 70 71 72 73 | |
call_tool
async
call_tool(
name: str,
arguments: dict[str, Any],
context: Context[LifespanContextT, RequestT],
convert_result: bool = False,
) -> Any
Call a tool by name with arguments.
Source code in src/mcp/server/mcpserver/tools/tool_manager.py
75 76 77 78 79 80 81 82 83 84 85 86 87 | |