-
Notifications
You must be signed in to change notification settings - Fork 35
Add capability of disabling tools #119
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
Open
zemin-piao
wants to merge
1
commit into
kubeflow:main
Choose a base branch
from
zemin-piao:add_capability_of_disabling_tools
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
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
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
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 |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| """Tool filtering utilities for conditional MCP tool registration.""" | ||
|
|
||
| import logging | ||
| import os | ||
| from typing import Callable, Optional, TypeVar | ||
|
|
||
| from spark_history_mcp.config.config import Config | ||
|
|
||
| F = TypeVar("F", bound=Callable) | ||
| # Configure logging | ||
| logging.basicConfig( | ||
| level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s" | ||
| ) | ||
| logger = logging.getLogger(__name__) | ||
|
|
||
|
|
||
| def is_tool_enabled(tool_name: str, config_path: str = "config.yaml") -> bool: | ||
| """ | ||
| Check if a tool is enabled based on configuration and environment variables. | ||
|
|
||
| Args: | ||
| tool_name: Name of the tool to check | ||
| config_path: Path to configuration file (default: "config.yaml") | ||
|
|
||
| Returns: | ||
| bool: True if tool is enabled, False if disabled | ||
| """ | ||
| # Check environment variable first (highest priority) | ||
| env_var = f"SHS_DISABLE_{tool_name.upper()}" | ||
| if os.getenv(env_var, "").lower() in ("true", "1", "yes"): | ||
| return False | ||
|
|
||
| # Check global environment variable for disabled tools | ||
| disabled_tools_env = os.getenv("SHS_GLOBAL_DISABLED_TOOLS", "") | ||
| if disabled_tools_env: | ||
| disabled_tools = [tool.strip() for tool in disabled_tools_env.split(",")] | ||
| if tool_name in disabled_tools: | ||
| return False | ||
|
|
||
| # Check configuration file | ||
| try: | ||
| config = Config.from_file(config_path) | ||
|
|
||
| # Check if any server has this tool disabled | ||
| for server_config in config.servers.values(): | ||
| if tool_name in server_config.disabled_tools: | ||
| return False | ||
|
|
||
| except Exception as e: | ||
| logger.error(f"Error loading configuration and loading disabled tools: {e}") | ||
| return True | ||
|
|
||
|
|
||
| def conditional_tool( | ||
| mcp_instance, tool_name: Optional[str] = None, config_path: str = "config.yaml" | ||
| ): | ||
| """ | ||
| Decorator that conditionally registers an MCP tool based on configuration. | ||
|
|
||
| Args: | ||
| mcp_instance: The FastMCP instance to register tools with | ||
| tool_name: Name of the tool (defaults to function name) | ||
| config_path: Path to configuration file | ||
|
|
||
| Returns: | ||
| Decorator function | ||
| """ | ||
|
|
||
| def decorator(func: F) -> F: | ||
| actual_tool_name = tool_name or func.__name__ | ||
|
|
||
| if is_tool_enabled(actual_tool_name, config_path): | ||
| # Tool is enabled, register it with MCP | ||
| return mcp_instance.tool()(func) | ||
| else: | ||
| # Tool is disabled, return unregistered function | ||
| return func | ||
|
|
||
| return decorator | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Possible to use the settings object for this instead?