mirror of
https://github.com/encounter/adk-python.git
synced 2026-07-09 18:19:28 -07:00
feat(tools): Implement toolset auth for McpToolset, OpenAPIToolset, and others
Update existing toolsets to utilize the new toolset authentication framework. Key changes:
- McpToolset: Add _auth_config instance variable, _get_auth_headers()
method to build auth headers from exchanged credentials, and
get_auth_config() override. Auth headers are now included when
creating MCP sessions.
- OpenAPIToolset: Add _auth_config and get_auth_config() to expose
auth configuration to the framework.
- ApplicationIntegrationToolset: Add _auth_config and get_auth_config().
- APIHubToolset: Add _auth_config and get_auth_config().
When ADK resolves toolset auth before calling get_tools(), it populates exchanged_auth_credential on the auth_config. Toolsets can then use this credential when making authenticated requests.
Also update test fixtures in test_apihub_toolset.py to use real auth objects instead of mocks that fail pydantic validation.
Co-authored-by: Xiang (Sean) Zhou <seanzhougoogle@google.com>
PiperOrigin-RevId: 863764941
This commit is contained in:
committed by
Copybara-Service
parent
ee873cae2e
commit
798f65df86
@@ -145,6 +145,16 @@ class APIHubToolset(BaseToolset):
|
||||
self._openapi_toolset = None
|
||||
self._auth_scheme = auth_scheme
|
||||
self._auth_credential = auth_credential
|
||||
# Store auth config as instance variable so ADK can populate
|
||||
# exchanged_auth_credential in-place before calling get_tools()
|
||||
self._auth_config: Optional[AuthConfig] = (
|
||||
AuthConfig(
|
||||
auth_scheme=auth_scheme,
|
||||
raw_auth_credential=auth_credential,
|
||||
)
|
||||
if auth_scheme
|
||||
else None
|
||||
)
|
||||
|
||||
if not self._lazy_load_spec:
|
||||
self._prepare_toolset()
|
||||
@@ -191,11 +201,11 @@ class APIHubToolset(BaseToolset):
|
||||
await self._openapi_toolset.close()
|
||||
|
||||
@override
|
||||
def get_auth_config(self) -> AuthConfig | None:
|
||||
"""Returns the auth config for this toolset."""
|
||||
if self._auth_scheme is None:
|
||||
return None
|
||||
return AuthConfig(
|
||||
auth_scheme=self._auth_scheme,
|
||||
raw_auth_credential=self._auth_credential,
|
||||
)
|
||||
def get_auth_config(self) -> Optional[AuthConfig]:
|
||||
"""Returns the auth config for this toolset.
|
||||
|
||||
ADK will populate exchanged_auth_credential on this config before calling
|
||||
get_tools(). The toolset can then access the ready-to-use credential via
|
||||
self._auth_config.exchanged_auth_credential.
|
||||
"""
|
||||
return self._auth_config
|
||||
|
||||
+18
-8
@@ -143,6 +143,16 @@ class ApplicationIntegrationToolset(BaseToolset):
|
||||
self._service_account_json = service_account_json
|
||||
self._auth_scheme = auth_scheme
|
||||
self._auth_credential = auth_credential
|
||||
# Store auth config as instance variable so ADK can populate
|
||||
# exchanged_auth_credential in-place before calling get_tools()
|
||||
self._auth_config: Optional[AuthConfig] = (
|
||||
AuthConfig(
|
||||
auth_scheme=auth_scheme,
|
||||
raw_auth_credential=auth_credential,
|
||||
)
|
||||
if auth_scheme
|
||||
else None
|
||||
)
|
||||
|
||||
integration_client = IntegrationClient(
|
||||
project,
|
||||
@@ -281,11 +291,11 @@ class ApplicationIntegrationToolset(BaseToolset):
|
||||
await self._openapi_toolset.close()
|
||||
|
||||
@override
|
||||
def get_auth_config(self) -> AuthConfig | None:
|
||||
"""Returns the auth config for this toolset."""
|
||||
if self._auth_scheme is None:
|
||||
return None
|
||||
return AuthConfig(
|
||||
auth_scheme=self._auth_scheme,
|
||||
raw_auth_credential=self._auth_credential,
|
||||
)
|
||||
def get_auth_config(self) -> Optional[AuthConfig]:
|
||||
"""Returns the auth config for this toolset.
|
||||
|
||||
ADK will populate exchanged_auth_credential on this config before calling
|
||||
get_tools(). The toolset can then access the ready-to-use credential via
|
||||
self._auth_config.exchanged_auth_credential.
|
||||
"""
|
||||
return self._auth_config
|
||||
|
||||
@@ -149,6 +149,82 @@ class McpToolset(BaseToolset):
|
||||
self._auth_scheme = auth_scheme
|
||||
self._auth_credential = auth_credential
|
||||
self._require_confirmation = require_confirmation
|
||||
# Store auth config as instance variable so ADK can populate
|
||||
# exchanged_auth_credential in-place before calling get_tools()
|
||||
self._auth_config: Optional[AuthConfig] = (
|
||||
AuthConfig(
|
||||
auth_scheme=auth_scheme,
|
||||
raw_auth_credential=auth_credential,
|
||||
)
|
||||
if auth_scheme
|
||||
else None
|
||||
)
|
||||
|
||||
def _get_auth_headers(self) -> Optional[Dict[str, str]]:
|
||||
"""Build authentication headers from exchanged credential.
|
||||
|
||||
Returns:
|
||||
Dictionary of auth headers, or None if no auth configured.
|
||||
"""
|
||||
if not self._auth_config or not self._auth_config.exchanged_auth_credential:
|
||||
return None
|
||||
|
||||
credential = self._auth_config.exchanged_auth_credential
|
||||
headers: Optional[Dict[str, str]] = None
|
||||
|
||||
if credential.oauth2:
|
||||
headers = {"Authorization": f"Bearer {credential.oauth2.access_token}"}
|
||||
elif credential.http:
|
||||
# Handle HTTP authentication schemes
|
||||
if (
|
||||
credential.http.scheme.lower() == "bearer"
|
||||
and credential.http.credentials
|
||||
and credential.http.credentials.token
|
||||
):
|
||||
headers = {
|
||||
"Authorization": f"Bearer {credential.http.credentials.token}"
|
||||
}
|
||||
elif credential.http.scheme.lower() == "basic":
|
||||
# Handle basic auth
|
||||
if (
|
||||
credential.http.credentials
|
||||
and credential.http.credentials.username
|
||||
and credential.http.credentials.password
|
||||
):
|
||||
credentials_str = (
|
||||
f"{credential.http.credentials.username}"
|
||||
f":{credential.http.credentials.password}"
|
||||
)
|
||||
encoded_credentials = base64.b64encode(
|
||||
credentials_str.encode()
|
||||
).decode()
|
||||
headers = {"Authorization": f"Basic {encoded_credentials}"}
|
||||
elif credential.http.credentials and credential.http.credentials.token:
|
||||
# Handle other HTTP schemes with token
|
||||
headers = {
|
||||
"Authorization": (
|
||||
f"{credential.http.scheme} {credential.http.credentials.token}"
|
||||
)
|
||||
}
|
||||
elif credential.api_key:
|
||||
# For API key, use the auth scheme to determine header name
|
||||
if self._auth_config.auth_scheme:
|
||||
from fastapi.openapi.models import APIKeyIn
|
||||
|
||||
if hasattr(self._auth_config.auth_scheme, "in_"):
|
||||
if self._auth_config.auth_scheme.in_ == APIKeyIn.header:
|
||||
headers = {self._auth_config.auth_scheme.name: credential.api_key}
|
||||
else:
|
||||
logger.warning(
|
||||
"McpToolset only supports header-based API key authentication."
|
||||
" Configured location: %s",
|
||||
self._auth_config.auth_scheme.in_,
|
||||
)
|
||||
else:
|
||||
# Default to using scheme name as header
|
||||
headers = {self._auth_config.auth_scheme.name: credential.api_key}
|
||||
|
||||
return headers
|
||||
|
||||
async def _execute_with_session(
|
||||
self,
|
||||
@@ -157,12 +233,22 @@ class McpToolset(BaseToolset):
|
||||
readonly_context: Optional[ReadonlyContext] = None,
|
||||
) -> T:
|
||||
"""Creates a session and executes a coroutine with it."""
|
||||
headers = (
|
||||
self._header_provider(readonly_context)
|
||||
if self._header_provider and readonly_context
|
||||
else None
|
||||
headers: Dict[str, str] = {}
|
||||
|
||||
# Add headers from header_provider if available
|
||||
if self._header_provider and readonly_context:
|
||||
provider_headers = self._header_provider(readonly_context)
|
||||
if provider_headers:
|
||||
headers.update(provider_headers)
|
||||
|
||||
# Add auth headers from exchanged credential if available
|
||||
auth_headers = self._get_auth_headers()
|
||||
if auth_headers:
|
||||
headers.update(auth_headers)
|
||||
|
||||
session = await self._mcp_session_manager.create_session(
|
||||
headers=headers if headers else None
|
||||
)
|
||||
session = await self._mcp_session_manager.create_session(headers=headers)
|
||||
timeout_in_seconds = (
|
||||
self._connection_params.timeout
|
||||
if hasattr(self._connection_params, "timeout")
|
||||
@@ -274,14 +360,14 @@ class McpToolset(BaseToolset):
|
||||
print(f"Warning: Error during McpToolset cleanup: {e}", file=self._errlog)
|
||||
|
||||
@override
|
||||
def get_auth_config(self) -> AuthConfig | None:
|
||||
"""Returns the auth config for this toolset."""
|
||||
if self._auth_scheme is None:
|
||||
return None
|
||||
return AuthConfig(
|
||||
auth_scheme=self._auth_scheme,
|
||||
raw_auth_credential=self._auth_credential,
|
||||
)
|
||||
def get_auth_config(self) -> Optional[AuthConfig]:
|
||||
"""Returns the auth config for this toolset.
|
||||
|
||||
ADK will populate exchanged_auth_credential on this config before calling
|
||||
get_tools(). The toolset can then access the ready-to-use credential via
|
||||
self._auth_config.exchanged_auth_credential.
|
||||
"""
|
||||
return self._auth_config
|
||||
|
||||
@override
|
||||
@classmethod
|
||||
|
||||
@@ -131,6 +131,16 @@ class OpenAPIToolset(BaseToolset):
|
||||
self._header_provider = header_provider
|
||||
self._auth_scheme = auth_scheme
|
||||
self._auth_credential = auth_credential
|
||||
# Store auth config as instance variable so ADK can populate
|
||||
# exchanged_auth_credential in-place before calling get_tools()
|
||||
self._auth_config: Optional[AuthConfig] = (
|
||||
AuthConfig(
|
||||
auth_scheme=auth_scheme,
|
||||
raw_auth_credential=auth_credential,
|
||||
)
|
||||
if auth_scheme
|
||||
else None
|
||||
)
|
||||
if not spec_dict:
|
||||
spec_dict = self._load_spec(spec_str, spec_str_type)
|
||||
self._ssl_verify = ssl_verify
|
||||
@@ -216,11 +226,11 @@ class OpenAPIToolset(BaseToolset):
|
||||
pass
|
||||
|
||||
@override
|
||||
def get_auth_config(self) -> AuthConfig | None:
|
||||
"""Returns the auth config for this toolset."""
|
||||
if self._auth_scheme is None:
|
||||
return None
|
||||
return AuthConfig(
|
||||
auth_scheme=self._auth_scheme,
|
||||
raw_auth_credential=self._auth_credential,
|
||||
)
|
||||
def get_auth_config(self) -> Optional[AuthConfig]:
|
||||
"""Returns the auth config for this toolset.
|
||||
|
||||
ADK will populate exchanged_auth_credential on this config before calling
|
||||
get_tools(). The toolset can then access the ready-to-use credential via
|
||||
self._auth_config.exchanged_auth_credential.
|
||||
"""
|
||||
return self._auth_config
|
||||
|
||||
Reference in New Issue
Block a user