datarobot-genai 0.2.3__py3-none-any.whl → 0.2.11__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- datarobot_genai/drmcp/core/config.py +52 -0
- datarobot_genai/drmcp/core/dr_mcp_server.py +11 -8
- datarobot_genai/drmcp/core/tool_config.py +95 -0
- datarobot_genai/drmcp/test_utils/openai_llm_mcp_client.py +6 -1
- datarobot_genai/drmcp/tools/clients/__init__.py +14 -0
- datarobot_genai/drmcp/tools/clients/atlassian.py +188 -0
- datarobot_genai/drmcp/tools/clients/confluence.py +196 -0
- datarobot_genai/drmcp/tools/clients/jira.py +147 -0
- datarobot_genai/drmcp/tools/clients/s3.py +28 -0
- datarobot_genai/drmcp/tools/confluence/__init__.py +14 -0
- datarobot_genai/drmcp/tools/confluence/tools.py +81 -0
- datarobot_genai/drmcp/tools/jira/__init__.py +14 -0
- datarobot_genai/drmcp/tools/jira/tools.py +52 -0
- datarobot_genai/drmcp/tools/predictive/predict.py +1 -1
- datarobot_genai/drmcp/tools/predictive/predict_realtime.py +1 -1
- datarobot_genai/nat/agent.py +4 -0
- datarobot_genai/nat/datarobot_auth_provider.py +110 -0
- datarobot_genai/nat/datarobot_mcp_client.py +234 -0
- {datarobot_genai-0.2.3.dist-info → datarobot_genai-0.2.11.dist-info}/METADATA +6 -1
- {datarobot_genai-0.2.3.dist-info → datarobot_genai-0.2.11.dist-info}/RECORD +24 -12
- {datarobot_genai-0.2.3.dist-info → datarobot_genai-0.2.11.dist-info}/entry_points.txt +2 -0
- {datarobot_genai-0.2.3.dist-info → datarobot_genai-0.2.11.dist-info}/WHEEL +0 -0
- {datarobot_genai-0.2.3.dist-info → datarobot_genai-0.2.11.dist-info}/licenses/AUTHORS +0 -0
- {datarobot_genai-0.2.3.dist-info → datarobot_genai-0.2.11.dist-info}/licenses/LICENSE +0 -0
|
@@ -197,6 +197,54 @@ class MCPServerConfig(BaseSettings):
|
|
|
197
197
|
description="Enable/disable predictive tools",
|
|
198
198
|
)
|
|
199
199
|
|
|
200
|
+
# Jira tools
|
|
201
|
+
enable_jira_tools: bool = Field(
|
|
202
|
+
default=False,
|
|
203
|
+
validation_alias=AliasChoices(
|
|
204
|
+
RUNTIME_PARAM_ENV_VAR_NAME_PREFIX + "ENABLE_JIRA_TOOLS",
|
|
205
|
+
"ENABLE_JIRA_TOOLS",
|
|
206
|
+
),
|
|
207
|
+
description="Enable/disable Jira tools",
|
|
208
|
+
)
|
|
209
|
+
is_jira_oauth_provider_configured: bool = Field(
|
|
210
|
+
default=False,
|
|
211
|
+
validation_alias=AliasChoices(
|
|
212
|
+
RUNTIME_PARAM_ENV_VAR_NAME_PREFIX + "IS_JIRA_OAUTH_PROVIDER_CONFIGURED",
|
|
213
|
+
"IS_JIRA_OAUTH_PROVIDER_CONFIGURED",
|
|
214
|
+
),
|
|
215
|
+
description="Whether Jira OAuth provider is configured for Jira integration",
|
|
216
|
+
)
|
|
217
|
+
|
|
218
|
+
@property
|
|
219
|
+
def is_jira_oauth_configured(self) -> bool:
|
|
220
|
+
return self.is_jira_oauth_provider_configured or bool(
|
|
221
|
+
os.getenv("JIRA_CLIENT_ID") and os.getenv("JIRA_CLIENT_SECRET")
|
|
222
|
+
)
|
|
223
|
+
|
|
224
|
+
# Confluence tools
|
|
225
|
+
enable_confluence_tools: bool = Field(
|
|
226
|
+
default=False,
|
|
227
|
+
validation_alias=AliasChoices(
|
|
228
|
+
RUNTIME_PARAM_ENV_VAR_NAME_PREFIX + "ENABLE_CONFLUENCE_TOOLS",
|
|
229
|
+
"ENABLE_CONFLUENCE_TOOLS",
|
|
230
|
+
),
|
|
231
|
+
description="Enable/disable Confluence tools",
|
|
232
|
+
)
|
|
233
|
+
is_confluence_oauth_provider_configured: bool = Field(
|
|
234
|
+
default=False,
|
|
235
|
+
validation_alias=AliasChoices(
|
|
236
|
+
RUNTIME_PARAM_ENV_VAR_NAME_PREFIX + "IS_CONFLUENCE_OAUTH_PROVIDER_CONFIGURED",
|
|
237
|
+
"IS_CONFLUENCE_OAUTH_PROVIDER_CONFIGURED",
|
|
238
|
+
),
|
|
239
|
+
description="Whether Confluence OAuth provider is configured for Confluence integration",
|
|
240
|
+
)
|
|
241
|
+
|
|
242
|
+
@property
|
|
243
|
+
def is_confluence_oauth_configured(self) -> bool:
|
|
244
|
+
return self.is_confluence_oauth_provider_configured or bool(
|
|
245
|
+
os.getenv("CONFLUENCE_CLIENT_ID") and os.getenv("CONFLUENCE_CLIENT_SECRET")
|
|
246
|
+
)
|
|
247
|
+
|
|
200
248
|
@field_validator(
|
|
201
249
|
"otel_attributes",
|
|
202
250
|
mode="before",
|
|
@@ -220,6 +268,10 @@ class MCPServerConfig(BaseSettings):
|
|
|
220
268
|
"tool_registration_duplicate_behavior",
|
|
221
269
|
"mcp_server_register_dynamic_prompts_on_startup",
|
|
222
270
|
"enable_predictive_tools",
|
|
271
|
+
"enable_jira_tools",
|
|
272
|
+
"is_jira_oauth_provider_configured",
|
|
273
|
+
"enable_confluence_tools",
|
|
274
|
+
"is_confluence_oauth_provider_configured",
|
|
223
275
|
mode="before",
|
|
224
276
|
)
|
|
225
277
|
@classmethod
|
|
@@ -40,6 +40,8 @@ from .routes_utils import prefix_mount_path
|
|
|
40
40
|
from .server_life_cycle import BaseServerLifecycle
|
|
41
41
|
from .telemetry import OtelASGIMiddleware
|
|
42
42
|
from .telemetry import initialize_telemetry
|
|
43
|
+
from .tool_config import TOOL_CONFIGS
|
|
44
|
+
from .tool_config import is_tool_enabled
|
|
43
45
|
|
|
44
46
|
|
|
45
47
|
def _import_modules_from_dir(
|
|
@@ -142,11 +144,12 @@ class DataRobotMCPServer:
|
|
|
142
144
|
|
|
143
145
|
# Load static tools modules
|
|
144
146
|
base_dir = os.path.dirname(os.path.dirname(__file__))
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
147
|
+
for tool_type, tool_config in TOOL_CONFIGS.items():
|
|
148
|
+
if is_tool_enabled(tool_type, self._config):
|
|
149
|
+
_import_modules_from_dir(
|
|
150
|
+
os.path.join(base_dir, "tools", tool_config["directory"]),
|
|
151
|
+
tool_config["package_prefix"],
|
|
152
|
+
)
|
|
150
153
|
|
|
151
154
|
# Load memory management tools if available
|
|
152
155
|
if self._memory_manager:
|
|
@@ -213,6 +216,9 @@ class DataRobotMCPServer:
|
|
|
213
216
|
self._logger.info("Registering dynamic prompts from prompt management...")
|
|
214
217
|
asyncio.run(register_prompts_from_datarobot_prompt_management())
|
|
215
218
|
|
|
219
|
+
# Execute pre-server start actions
|
|
220
|
+
asyncio.run(self._lifecycle.pre_server_start(self._mcp))
|
|
221
|
+
|
|
216
222
|
# List registered tools, prompts, and resources before starting server
|
|
217
223
|
tools = asyncio.run(self._mcp._list_tools_mcp())
|
|
218
224
|
prompts = asyncio.run(self._mcp._list_prompts_mcp())
|
|
@@ -232,9 +238,6 @@ class DataRobotMCPServer:
|
|
|
232
238
|
for resource in resources:
|
|
233
239
|
self._logger.info(f" > {resource.name}")
|
|
234
240
|
|
|
235
|
-
# Execute pre-server start actions
|
|
236
|
-
asyncio.run(self._lifecycle.pre_server_start(self._mcp))
|
|
237
|
-
|
|
238
241
|
# Create event loop for async operations
|
|
239
242
|
loop = asyncio.new_event_loop()
|
|
240
243
|
asyncio.set_event_loop(loop)
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# Copyright 2025 DataRobot, Inc.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""Tool configuration and enablement logic."""
|
|
16
|
+
|
|
17
|
+
from collections.abc import Callable
|
|
18
|
+
from enum import Enum
|
|
19
|
+
from typing import TYPE_CHECKING
|
|
20
|
+
from typing import TypedDict
|
|
21
|
+
|
|
22
|
+
if TYPE_CHECKING:
|
|
23
|
+
from .config import MCPServerConfig
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
class ToolType(str, Enum):
|
|
27
|
+
"""Enumeration of available tool types."""
|
|
28
|
+
|
|
29
|
+
PREDICTIVE = "predictive"
|
|
30
|
+
JIRA = "jira"
|
|
31
|
+
CONFLUENCE = "confluence"
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class ToolConfig(TypedDict):
|
|
35
|
+
"""Configuration for a tool type."""
|
|
36
|
+
|
|
37
|
+
name: str
|
|
38
|
+
oauth_check: Callable[["MCPServerConfig"], bool] | None
|
|
39
|
+
directory: str
|
|
40
|
+
package_prefix: str
|
|
41
|
+
config_field_name: str # Name of the config field (e.g., "enable_predictive_tools")
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
# Tool configuration registry
|
|
45
|
+
TOOL_CONFIGS: dict[ToolType, ToolConfig] = {
|
|
46
|
+
ToolType.PREDICTIVE: ToolConfig(
|
|
47
|
+
name="predictive",
|
|
48
|
+
oauth_check=None,
|
|
49
|
+
directory="predictive",
|
|
50
|
+
package_prefix="datarobot_genai.drmcp.tools.predictive",
|
|
51
|
+
config_field_name="enable_predictive_tools",
|
|
52
|
+
),
|
|
53
|
+
ToolType.JIRA: ToolConfig(
|
|
54
|
+
name="jira",
|
|
55
|
+
oauth_check=lambda config: config.is_jira_oauth_configured,
|
|
56
|
+
directory="jira",
|
|
57
|
+
package_prefix="datarobot_genai.drmcp.tools.jira",
|
|
58
|
+
config_field_name="enable_jira_tools",
|
|
59
|
+
),
|
|
60
|
+
ToolType.CONFLUENCE: ToolConfig(
|
|
61
|
+
name="confluence",
|
|
62
|
+
oauth_check=lambda config: config.is_confluence_oauth_configured,
|
|
63
|
+
directory="confluence",
|
|
64
|
+
package_prefix="datarobot_genai.drmcp.tools.confluence",
|
|
65
|
+
config_field_name="enable_confluence_tools",
|
|
66
|
+
),
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
def get_tool_enable_config_name(tool_type: ToolType) -> str:
|
|
71
|
+
"""Get the configuration field name for enabling a tool."""
|
|
72
|
+
return TOOL_CONFIGS[tool_type]["config_field_name"]
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
def is_tool_enabled(tool_type: ToolType, config: "MCPServerConfig") -> bool:
|
|
76
|
+
"""
|
|
77
|
+
Check if a tool is enabled based on configuration.
|
|
78
|
+
|
|
79
|
+
Args:
|
|
80
|
+
tool_type: The type of tool to check
|
|
81
|
+
config: The server configuration
|
|
82
|
+
|
|
83
|
+
Returns
|
|
84
|
+
-------
|
|
85
|
+
True if the tool is enabled, False otherwise
|
|
86
|
+
"""
|
|
87
|
+
tool_config = TOOL_CONFIGS[tool_type]
|
|
88
|
+
enable_config_name = tool_config["config_field_name"]
|
|
89
|
+
is_enabled = getattr(config, enable_config_name)
|
|
90
|
+
|
|
91
|
+
# If tool is enabled, check OAuth requirements if needed
|
|
92
|
+
if is_enabled and tool_config["oauth_check"] is not None:
|
|
93
|
+
return tool_config["oauth_check"](config)
|
|
94
|
+
|
|
95
|
+
return is_enabled
|
|
@@ -95,11 +95,16 @@ class LLMMCPClient:
|
|
|
95
95
|
) -> str:
|
|
96
96
|
"""Call an MCP tool and return the result as a string."""
|
|
97
97
|
result: CallToolResult = await mcp_session.call_tool(tool_name, parameters)
|
|
98
|
-
|
|
98
|
+
content = (
|
|
99
99
|
result.content[0].text
|
|
100
100
|
if result.content and isinstance(result.content[0], TextContent)
|
|
101
101
|
else str(result.content)
|
|
102
102
|
)
|
|
103
|
+
if result.structuredContent is not None:
|
|
104
|
+
structured_content = json.dumps(result.structuredContent)
|
|
105
|
+
else:
|
|
106
|
+
structured_content = ""
|
|
107
|
+
return f"Content: {content}\nStructured content: {structured_content}"
|
|
103
108
|
|
|
104
109
|
async def _process_tool_calls(
|
|
105
110
|
self,
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Copyright 2025 DataRobot, Inc.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
# Copyright 2025 DataRobot, Inc.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""Atlassian API client utilities for OAuth and cloud ID management."""
|
|
16
|
+
|
|
17
|
+
import logging
|
|
18
|
+
from typing import Any
|
|
19
|
+
from typing import Literal
|
|
20
|
+
|
|
21
|
+
import httpx
|
|
22
|
+
from datarobot.auth.datarobot.exceptions import OAuthServiceClientErr
|
|
23
|
+
from fastmcp.exceptions import ToolError
|
|
24
|
+
|
|
25
|
+
from datarobot_genai.drmcp.core.auth import get_access_token
|
|
26
|
+
|
|
27
|
+
logger = logging.getLogger(__name__)
|
|
28
|
+
|
|
29
|
+
# Atlassian Cloud API base URL
|
|
30
|
+
ATLASSIAN_API_BASE = "https://api.atlassian.com"
|
|
31
|
+
|
|
32
|
+
# API endpoint paths
|
|
33
|
+
OAUTH_ACCESSIBLE_RESOURCES_PATH = "/oauth/token/accessible-resources"
|
|
34
|
+
|
|
35
|
+
# Supported Atlassian service types
|
|
36
|
+
AtlassianServiceType = Literal["jira", "confluence"]
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
async def get_atlassian_access_token() -> str | ToolError:
|
|
40
|
+
"""
|
|
41
|
+
Get Atlassian OAuth access token with error handling.
|
|
42
|
+
|
|
43
|
+
Returns
|
|
44
|
+
-------
|
|
45
|
+
Access token string on success, ToolError on failure
|
|
46
|
+
|
|
47
|
+
Example:
|
|
48
|
+
```python
|
|
49
|
+
token = await get_atlassian_access_token()
|
|
50
|
+
if isinstance(token, ToolError):
|
|
51
|
+
# Handle error
|
|
52
|
+
return token
|
|
53
|
+
# Use token
|
|
54
|
+
```
|
|
55
|
+
"""
|
|
56
|
+
try:
|
|
57
|
+
access_token = await get_access_token("atlassian")
|
|
58
|
+
if not access_token:
|
|
59
|
+
logger.warning("Empty access token received")
|
|
60
|
+
return ToolError("Received empty access token. Please complete the OAuth flow.")
|
|
61
|
+
return access_token
|
|
62
|
+
except OAuthServiceClientErr as e:
|
|
63
|
+
logger.error(f"OAuth client error: {e}", exc_info=True)
|
|
64
|
+
return ToolError(
|
|
65
|
+
"Could not obtain access token for Atlassian. Make sure the OAuth "
|
|
66
|
+
"permission was granted for the application to act on your behalf."
|
|
67
|
+
)
|
|
68
|
+
except Exception as e:
|
|
69
|
+
logger.error(f"Unexpected error obtaining access token: {e}", exc_info=True)
|
|
70
|
+
return ToolError("An unexpected error occurred while obtaining access token for Atlassian.")
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
def _find_resource_by_service(
|
|
74
|
+
resources: list[dict[str, Any]], service_type: str
|
|
75
|
+
) -> dict[str, Any] | None:
|
|
76
|
+
"""
|
|
77
|
+
Find a resource that matches the specified service type.
|
|
78
|
+
|
|
79
|
+
Args:
|
|
80
|
+
resources: List of accessible resources from Atlassian API
|
|
81
|
+
service_type: Service type to filter by (e.g., "jira", "confluence")
|
|
82
|
+
|
|
83
|
+
Returns
|
|
84
|
+
-------
|
|
85
|
+
Resource dictionary if found, None otherwise
|
|
86
|
+
"""
|
|
87
|
+
service_lower = service_type.lower()
|
|
88
|
+
for resource in resources:
|
|
89
|
+
if not resource.get("id"):
|
|
90
|
+
continue
|
|
91
|
+
scopes = resource.get("scopes", [])
|
|
92
|
+
if any(service_lower in scope.lower() for scope in scopes):
|
|
93
|
+
return resource
|
|
94
|
+
return None
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
def _find_first_resource_with_id(resources: list[dict[str, Any]]) -> dict[str, Any] | None:
|
|
98
|
+
"""
|
|
99
|
+
Find the first resource that has an ID.
|
|
100
|
+
|
|
101
|
+
Args:
|
|
102
|
+
resources: List of accessible resources from Atlassian API
|
|
103
|
+
|
|
104
|
+
Returns
|
|
105
|
+
-------
|
|
106
|
+
Resource dictionary if found, None otherwise
|
|
107
|
+
"""
|
|
108
|
+
for resource in resources:
|
|
109
|
+
if resource.get("id"):
|
|
110
|
+
return resource
|
|
111
|
+
return None
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
async def get_atlassian_cloud_id(
|
|
115
|
+
client: httpx.AsyncClient,
|
|
116
|
+
service_type: AtlassianServiceType | None = None,
|
|
117
|
+
) -> str:
|
|
118
|
+
"""
|
|
119
|
+
Get the cloud ID for the authenticated Atlassian instance.
|
|
120
|
+
|
|
121
|
+
According to Atlassian OAuth 2.0 documentation, API calls should use:
|
|
122
|
+
https://api.atlassian.com/ex/{service}/{cloudId}/rest/api/3/...
|
|
123
|
+
|
|
124
|
+
Args:
|
|
125
|
+
client: HTTP client with authentication headers configured
|
|
126
|
+
service_type: Optional service type to filter by (e.g., "jira", "confluence").
|
|
127
|
+
If provided, will prioritize resources matching this service type.
|
|
128
|
+
|
|
129
|
+
Returns
|
|
130
|
+
-------
|
|
131
|
+
Cloud ID string for the Atlassian instance
|
|
132
|
+
|
|
133
|
+
Raises
|
|
134
|
+
------
|
|
135
|
+
ValueError: If cloud ID cannot be retrieved due to:
|
|
136
|
+
- No accessible resources found
|
|
137
|
+
- No cloud ID found in resources
|
|
138
|
+
- Authentication failure (401)
|
|
139
|
+
- HTTP request failure
|
|
140
|
+
|
|
141
|
+
Example:
|
|
142
|
+
```python
|
|
143
|
+
client = httpx.AsyncClient(headers={"Authorization": f"Bearer {token}"})
|
|
144
|
+
cloud_id = await get_atlassian_cloud_id(client, service_type="jira")
|
|
145
|
+
```
|
|
146
|
+
"""
|
|
147
|
+
url = f"{ATLASSIAN_API_BASE}{OAUTH_ACCESSIBLE_RESOURCES_PATH}"
|
|
148
|
+
|
|
149
|
+
try:
|
|
150
|
+
response = await client.get(url)
|
|
151
|
+
response.raise_for_status()
|
|
152
|
+
resources = response.json()
|
|
153
|
+
|
|
154
|
+
if not resources:
|
|
155
|
+
raise ValueError(
|
|
156
|
+
"No accessible resources found. Ensure OAuth token has required scopes."
|
|
157
|
+
)
|
|
158
|
+
|
|
159
|
+
# If service_type is specified, try to find matching resource
|
|
160
|
+
if service_type:
|
|
161
|
+
resource = _find_resource_by_service(resources, service_type)
|
|
162
|
+
if resource:
|
|
163
|
+
cloud_id = resource["id"]
|
|
164
|
+
logger.debug(f"Using {service_type} cloud ID: {cloud_id}")
|
|
165
|
+
return cloud_id
|
|
166
|
+
logger.warning(
|
|
167
|
+
f"No {service_type} resource found, falling back to first available resource"
|
|
168
|
+
)
|
|
169
|
+
|
|
170
|
+
# Fallback: use the first resource with an ID
|
|
171
|
+
resource = _find_first_resource_with_id(resources)
|
|
172
|
+
if resource:
|
|
173
|
+
cloud_id = resource["id"]
|
|
174
|
+
logger.debug(f"Using cloud ID (fallback): {cloud_id}")
|
|
175
|
+
return cloud_id
|
|
176
|
+
|
|
177
|
+
raise ValueError("No cloud ID found in accessible resources")
|
|
178
|
+
except httpx.HTTPStatusError as e:
|
|
179
|
+
if e.response.status_code == 401:
|
|
180
|
+
raise ValueError(
|
|
181
|
+
"Authentication failed. Token may be expired. "
|
|
182
|
+
"Complete OAuth flow again: GET /oauth/atlassian/authorize"
|
|
183
|
+
) from e
|
|
184
|
+
logger.error(f"HTTP error getting cloud ID: {e.response.status_code}")
|
|
185
|
+
raise ValueError(f"Failed to get Atlassian cloud ID: HTTP {e.response.status_code}") from e
|
|
186
|
+
except httpx.RequestError as e:
|
|
187
|
+
logger.error(f"Request error getting cloud ID: {e}")
|
|
188
|
+
raise ValueError("Failed to get Atlassian cloud ID: Network error") from e
|
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
# Copyright 2025 DataRobot, Inc.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""Async client for interacting with Confluence Cloud REST API.
|
|
16
|
+
|
|
17
|
+
At the moment of creating this client, official Confluence SDK is not supporting async.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
import logging
|
|
21
|
+
from http import HTTPStatus
|
|
22
|
+
from typing import Any
|
|
23
|
+
|
|
24
|
+
import httpx
|
|
25
|
+
from pydantic import BaseModel
|
|
26
|
+
from pydantic import Field
|
|
27
|
+
|
|
28
|
+
from .atlassian import ATLASSIAN_API_BASE
|
|
29
|
+
from .atlassian import get_atlassian_cloud_id
|
|
30
|
+
|
|
31
|
+
logger = logging.getLogger(__name__)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class ConfluencePage(BaseModel):
|
|
35
|
+
"""Pydantic model for Confluence page."""
|
|
36
|
+
|
|
37
|
+
page_id: str = Field(..., description="The unique page ID")
|
|
38
|
+
title: str = Field(..., description="Page title")
|
|
39
|
+
space_id: str = Field(..., description="Space ID where the page resides")
|
|
40
|
+
space_key: str | None = Field(None, description="Space key (if available)")
|
|
41
|
+
body: str = Field(..., description="Page content in storage format (HTML-like)")
|
|
42
|
+
|
|
43
|
+
def as_flat_dict(self) -> dict[str, Any]:
|
|
44
|
+
"""Return a flat dictionary representation of the page."""
|
|
45
|
+
return {
|
|
46
|
+
"page_id": self.page_id,
|
|
47
|
+
"title": self.title,
|
|
48
|
+
"space_id": self.space_id,
|
|
49
|
+
"space_key": self.space_key,
|
|
50
|
+
"body": self.body,
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
class ConfluenceClient:
|
|
55
|
+
"""
|
|
56
|
+
Client for interacting with Confluence API using OAuth access token.
|
|
57
|
+
|
|
58
|
+
At the moment of creating this client, official Confluence SDK is not supporting async.
|
|
59
|
+
"""
|
|
60
|
+
|
|
61
|
+
EXPAND_FIELDS = "body.storage,space"
|
|
62
|
+
|
|
63
|
+
def __init__(self, access_token: str) -> None:
|
|
64
|
+
"""
|
|
65
|
+
Initialize Confluence client with access token.
|
|
66
|
+
|
|
67
|
+
Args:
|
|
68
|
+
access_token: OAuth access token for Atlassian API
|
|
69
|
+
"""
|
|
70
|
+
self.access_token = access_token
|
|
71
|
+
self._client = httpx.AsyncClient(
|
|
72
|
+
headers={
|
|
73
|
+
"Authorization": f"Bearer {access_token}",
|
|
74
|
+
"Accept": "application/json",
|
|
75
|
+
"Content-Type": "application/json",
|
|
76
|
+
},
|
|
77
|
+
timeout=30.0,
|
|
78
|
+
)
|
|
79
|
+
self._cloud_id: str | None = None
|
|
80
|
+
|
|
81
|
+
async def _get_cloud_id(self) -> str:
|
|
82
|
+
"""
|
|
83
|
+
Get the cloud ID for the authenticated Atlassian Confluence instance.
|
|
84
|
+
|
|
85
|
+
According to Atlassian OAuth 2.0 documentation, API calls should use:
|
|
86
|
+
https://api.atlassian.com/ex/confluence/{cloudId}/wiki/rest/api/...
|
|
87
|
+
|
|
88
|
+
Returns
|
|
89
|
+
-------
|
|
90
|
+
Cloud ID string
|
|
91
|
+
|
|
92
|
+
Raises
|
|
93
|
+
------
|
|
94
|
+
ValueError: If cloud ID cannot be retrieved
|
|
95
|
+
"""
|
|
96
|
+
if self._cloud_id:
|
|
97
|
+
return self._cloud_id
|
|
98
|
+
|
|
99
|
+
self._cloud_id = await get_atlassian_cloud_id(self._client, service_type="confluence")
|
|
100
|
+
return self._cloud_id
|
|
101
|
+
|
|
102
|
+
def _parse_response(self, data: dict) -> ConfluencePage:
|
|
103
|
+
"""Parse API response into ConfluencePage."""
|
|
104
|
+
body_content = ""
|
|
105
|
+
body = data.get("body", {})
|
|
106
|
+
if isinstance(body, dict):
|
|
107
|
+
storage = body.get("storage", {})
|
|
108
|
+
if isinstance(storage, dict):
|
|
109
|
+
body_content = storage.get("value", "")
|
|
110
|
+
|
|
111
|
+
space = data.get("space", {})
|
|
112
|
+
space_key = space.get("key") if isinstance(space, dict) else None
|
|
113
|
+
space_id = space.get("id", "") if isinstance(space, dict) else data.get("spaceId", "")
|
|
114
|
+
|
|
115
|
+
return ConfluencePage(
|
|
116
|
+
page_id=str(data.get("id", "")),
|
|
117
|
+
title=data.get("title", ""),
|
|
118
|
+
space_id=str(space_id),
|
|
119
|
+
space_key=space_key,
|
|
120
|
+
body=body_content,
|
|
121
|
+
)
|
|
122
|
+
|
|
123
|
+
async def get_page_by_id(self, page_id: str) -> ConfluencePage:
|
|
124
|
+
"""
|
|
125
|
+
Get a Confluence page by its ID.
|
|
126
|
+
|
|
127
|
+
Args:
|
|
128
|
+
page_id: The numeric page ID
|
|
129
|
+
|
|
130
|
+
Returns
|
|
131
|
+
-------
|
|
132
|
+
ConfluencePage with page data
|
|
133
|
+
|
|
134
|
+
Raises
|
|
135
|
+
------
|
|
136
|
+
ValueError: If page is not found
|
|
137
|
+
httpx.HTTPStatusError: If the API request fails
|
|
138
|
+
"""
|
|
139
|
+
cloud_id = await self._get_cloud_id()
|
|
140
|
+
url = f"{ATLASSIAN_API_BASE}/ex/confluence/{cloud_id}/wiki/rest/api/content/{page_id}"
|
|
141
|
+
|
|
142
|
+
response = await self._client.get(url, params={"expand": self.EXPAND_FIELDS})
|
|
143
|
+
|
|
144
|
+
if response.status_code == HTTPStatus.NOT_FOUND:
|
|
145
|
+
raise ValueError(f"Page with ID '{page_id}' not found")
|
|
146
|
+
|
|
147
|
+
response.raise_for_status()
|
|
148
|
+
return self._parse_response(response.json())
|
|
149
|
+
|
|
150
|
+
async def get_page_by_title(self, title: str, space_key: str) -> ConfluencePage:
|
|
151
|
+
"""
|
|
152
|
+
Get a Confluence page by its title within a specific space.
|
|
153
|
+
|
|
154
|
+
Args:
|
|
155
|
+
title: The exact page title
|
|
156
|
+
space_key: The space key where the page resides
|
|
157
|
+
|
|
158
|
+
Returns
|
|
159
|
+
-------
|
|
160
|
+
ConfluencePage with page data
|
|
161
|
+
|
|
162
|
+
Raises
|
|
163
|
+
------
|
|
164
|
+
ValueError: If the page is not found
|
|
165
|
+
httpx.HTTPStatusError: If the API request fails
|
|
166
|
+
"""
|
|
167
|
+
cloud_id = await self._get_cloud_id()
|
|
168
|
+
url = f"{ATLASSIAN_API_BASE}/ex/confluence/{cloud_id}/wiki/rest/api/content"
|
|
169
|
+
|
|
170
|
+
response = await self._client.get(
|
|
171
|
+
url,
|
|
172
|
+
params={
|
|
173
|
+
"title": title,
|
|
174
|
+
"spaceKey": space_key,
|
|
175
|
+
"expand": self.EXPAND_FIELDS,
|
|
176
|
+
},
|
|
177
|
+
)
|
|
178
|
+
response.raise_for_status()
|
|
179
|
+
|
|
180
|
+
data = response.json()
|
|
181
|
+
results = data.get("results", [])
|
|
182
|
+
|
|
183
|
+
if not results:
|
|
184
|
+
raise ValueError(f"Page with title '{title}' not found in space '{space_key}'")
|
|
185
|
+
|
|
186
|
+
return self._parse_response(results[0])
|
|
187
|
+
|
|
188
|
+
async def __aenter__(self) -> "ConfluenceClient":
|
|
189
|
+
"""Async context manager entry."""
|
|
190
|
+
return self
|
|
191
|
+
|
|
192
|
+
async def __aexit__(
|
|
193
|
+
self, exc_type: type[BaseException] | None, exc_val: BaseException | None, exc_tb: Any
|
|
194
|
+
) -> None:
|
|
195
|
+
"""Async context manager exit."""
|
|
196
|
+
await self._client.aclose()
|