-
Notifications
You must be signed in to change notification settings - Fork 3
Docstrings and exceptions #25
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
Merged
Merged
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,23 @@ | ||
from .mcpd_client import McpdClient, McpdError | ||
from .exceptions import ( | ||
AuthenticationError, | ||
ConnectionError, | ||
McpdError, | ||
ServerNotFoundError, | ||
TimeoutError, | ||
ToolExecutionError, | ||
ToolNotFoundError, | ||
ValidationError, | ||
) | ||
from .mcpd_client import McpdClient | ||
|
||
__all__ = [ | ||
"McpdClient", | ||
"McpdError", | ||
"AuthenticationError", | ||
"ConnectionError", | ||
"ServerNotFoundError", | ||
"TimeoutError", | ||
"ToolExecutionError", | ||
"ToolNotFoundError", | ||
"ValidationError", | ||
] |
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 |
---|---|---|
@@ -1,30 +1,157 @@ | ||
from .exceptions import McpdError | ||
from .exceptions import McpdError, ToolNotFoundError | ||
|
||
|
||
class DynamicCaller: | ||
"""Helper class to enable client.call.<server_name>.<tool_name>(**kwargs) syntax.""" | ||
""" | ||
Enables dynamic, attribute-based tool invocation using natural Python syntax. | ||
def __init__(self, client): | ||
This class provides the magic behind the client.call.<server>.<tool>(**kwargs) syntax, | ||
allowing you to call MCP tools as if they were native Python methods. It uses Python's | ||
__getattr__ to dynamically resolve server and tool names at runtime. | ||
The DynamicCaller is automatically instantiated as the 'call' attribute on McpdClient | ||
and should not be created directly. | ||
Attributes: | ||
_client: Reference to the parent McpdClient instance. | ||
Example: | ||
>>> client = McpdClient(api_endpoint="http://localhost:8090") | ||
>>> | ||
>>> # Access tools through natural attribute syntax | ||
>>> # Instead of: client._perform_call("time", "get_current_time", {"timezone": "UTC"}) | ||
>>> # You can write: | ||
>>> result = client.call.time.get_current_time(timezone="UTC") | ||
>>> | ||
>>> # Works with any server and tool name | ||
>>> weather = client.call.duckduckgo_mcp.searsch(query="Tokyo", max_results=3) | ||
>>> commits = client.call.mcp_discord.discord_read_messages(channelId="9223372036854775806", limit=10) | ||
Note: | ||
Tool and server names are resolved at runtime. If a server or tool doesn't exist, | ||
an McpdError will be raised when you attempt to call it. Use client.has_tool() | ||
to check availability before calling if needed. | ||
""" | ||
|
||
def __init__(self, client: "McpdClient"): | ||
""" | ||
Initialize the DynamicCaller with a reference to the client. | ||
Args: | ||
client: The McpdClient instance that owns this DynamicCaller. | ||
""" | ||
self._client = client | ||
|
||
def __getattr__(self, server_name: str): | ||
"""Get a server proxy for dynamic tool calling.""" | ||
def __getattr__(self, server_name: str) -> "ServerProxy": | ||
""" | ||
Create a ServerProxy for the specified server name. | ||
This method is called when accessing an attribute on the DynamicCaller, | ||
e.g., client.call.time returns a ServerProxy for the "time" server. | ||
Args: | ||
server_name: The name of the MCP server to create a proxy for. | ||
Returns: | ||
A ServerProxy instance that can be used to call tools on that server. | ||
Example: | ||
>>> # When you write: client.call.time | ||
>>> # Python calls: client.call.__getattr__("time") | ||
>>> # Which returns: ServerProxy(client, "time") | ||
""" | ||
return ServerProxy(self._client, server_name) | ||
|
||
|
||
class ServerProxy: | ||
"""Proxy class for server-specific tool calling.""" | ||
""" | ||
Proxy for a specific MCP server, enabling tool invocation via attributes. | ||
This class represents a specific MCP server and allows calling its tools | ||
as if they were methods. It's created automatically by DynamicCaller and | ||
should not be instantiated directly. | ||
Attributes: | ||
_client: Reference to the McpdClient instance. | ||
_server_name: Name of the MCP server this proxy represents. | ||
def __init__(self, client, server_name: str): | ||
Example: | ||
>>> # ServerProxy is created when you access a server: | ||
>>> time_server = client.call.time # Returns ServerProxy(client, "time") | ||
>>> | ||
>>> # You can then call tools on it: | ||
>>> current_time = time_server.get_current_time(timezone="UTC") | ||
>>> | ||
>>> # Or chain it directly: | ||
>>> current_time = client.call.time.get_current_time(timezone="UTC") | ||
""" | ||
|
||
def __init__(self, client: "McpdClient", server_name: str): | ||
""" | ||
Initialize a ServerProxy for a specific server. | ||
Args: | ||
client: The McpdClient instance to use for API calls. | ||
server_name: The name of the MCP server this proxy represents. | ||
""" | ||
self._client = client | ||
self._server_name = server_name | ||
|
||
def __getattr__(self, tool_name: str): | ||
"""Get a tool callable.""" | ||
def __getattr__(self, tool_name: str) -> callable: | ||
""" | ||
Create a callable function for the specified tool. | ||
When you access an attribute on a ServerProxy (e.g., time_server.get_current_time), | ||
this method creates and returns a function that will call that tool when invoked. | ||
Args: | ||
tool_name: The name of the tool to create a callable for. | ||
Returns: | ||
A callable function that accepts keyword arguments and invokes the tool. | ||
Raises: | ||
McpdError: If the tool doesn't exist on this server. | ||
Example: | ||
>>> # When you write: client.call.time.get_current_time | ||
>>> # Python calls: ServerProxy.__getattr__("get_current_time") | ||
>>> # Which returns a function that calls the tool | ||
>>> | ||
>>> # The returned function can then be called: | ||
>>> result = client.call.time.get_current_time(timezone="UTC") | ||
>>> | ||
>>> # You can also store the function reference: | ||
>>> get_time = client.call.time.get_current_time | ||
>>> tokyo_time = get_time(timezone="Asia/Tokyo") | ||
>>> london_time = get_time(timezone="Europe/London") | ||
""" | ||
if not self._client.has_tool(self._server_name, tool_name): | ||
raise McpdError(f"Tool '{tool_name}' not found on server '{self._server_name}'") | ||
raise ToolNotFoundError( | ||
f"Tool '{tool_name}' not found on server '{self._server_name}'. " | ||
f"Use client.tools('{self._server_name}') to see available tools.", | ||
server_name=self._server_name, | ||
tool_name=tool_name, | ||
) | ||
|
||
def tool_function(**kwargs): | ||
""" | ||
Execute the MCP tool with the provided parameters. | ||
Args: | ||
**kwargs: Tool parameters as keyword arguments. | ||
These should match the tool's inputSchema. | ||
def tool_callable(**kwargs): | ||
Returns: | ||
The tool's response, typically a dictionary with the results. | ||
Raises: | ||
McpdError: If the tool execution fails for any reason. | ||
""" | ||
return self._client._perform_call(self._server_name, tool_name, kwargs) | ||
|
||
return tool_callable | ||
# Add metadata to help with debugging and introspection | ||
tool_function.__name__ = f"{self._server_name}__{tool_name}" | ||
tool_function.__qualname__ = f"ServerProxy.{tool_name}" | ||
|
||
return tool_function |
Oops, something went wrong.
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.