-
Notifications
You must be signed in to change notification settings - Fork 124
Expand file tree
/
Copy pathtools_multiproject.py
More file actions
512 lines (469 loc) · 16.1 KB
/
Copy pathtools_multiproject.py
File metadata and controls
512 lines (469 loc) · 16.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
import logging
from dataclasses import dataclass
from typing import Annotated
from mcp.server.fastmcp import FastMCP
from pydantic import Field
from dbt_mcp.config.config_providers import (
DiscoveryConfig,
MultiProjectConfigProvider,
MultiProjectDiscoveryConfigProvider,
)
from dbt_mcp.discovery.client import (
AppliedResourceType,
ExposuresFetcher,
LineageFetcher,
MacrosFetcher,
ModelPerformanceFetcher,
ModelsFetcher,
PaginatedResourceFetcher,
ResourceDetailsFetcher,
SourcesFetcher,
)
from dbt_mcp.discovery.param_descriptions import (
DISCOVERY_PROJECT_ID_DESCRIPTION,
MACRO_INCLUDE_DEFAULT_DBT_PACKAGES,
MACRO_PACKAGE_NAMES,
MACRO_RETURN_PACKAGE_NAMES_ONLY,
MODEL_PERF_INCLUDE_TESTS,
MODEL_PERF_NUM_RUNS,
SOURCE_NAMES_FILTER,
SOURCE_UNIQUE_IDS_FILTER,
)
from dbt_mcp.prompts.prompts import get_prompt
from dbt_mcp.tools.definitions import dbt_mcp_tool
from dbt_mcp.tools.fields import (
DEPTH_FIELD,
NAME_FIELD,
TYPES_FIELD,
UNIQUE_ID_FIELD,
UNIQUE_ID_REQUIRED_FIELD,
)
from dbt_mcp.tools.parameters import LineageResourceType
from dbt_mcp.tools.register import register_tools
from dbt_mcp.tools.tool_names import ToolName
from dbt_mcp.tools.toolsets import Toolset
logger = logging.getLogger(__name__)
@dataclass
class MultiProjectDiscoveryToolContext:
config_provider: MultiProjectConfigProvider[DiscoveryConfig]
models_fetcher: ModelsFetcher
exposures_fetcher: ExposuresFetcher
sources_fetcher: SourcesFetcher
macros_fetcher: MacrosFetcher
resource_details_fetcher: ResourceDetailsFetcher
lineage_fetcher: LineageFetcher
model_performance_fetcher: ModelPerformanceFetcher
def __init__(
self,
*,
config_provider: MultiProjectConfigProvider[DiscoveryConfig],
):
self.config_provider = config_provider
self.models_fetcher = ModelsFetcher(
paginator=PaginatedResourceFetcher(
edges_path=("data", "environment", "applied", "models", "edges"),
page_info_path=("data", "environment", "applied", "models", "pageInfo"),
),
)
self.exposures_fetcher = ExposuresFetcher(
paginator=PaginatedResourceFetcher(
edges_path=("data", "environment", "definition", "exposures", "edges"),
page_info_path=(
"data",
"environment",
"definition",
"exposures",
"pageInfo",
),
),
)
self.sources_fetcher = SourcesFetcher(
paginator=PaginatedResourceFetcher(
edges_path=("data", "environment", "applied", "sources", "edges"),
page_info_path=(
"data",
"environment",
"applied",
"sources",
"pageInfo",
),
),
)
self.macros_fetcher = MacrosFetcher(
paginator=PaginatedResourceFetcher(
edges_path=("data", "environment", "applied", "resources", "edges"),
page_info_path=(
"data",
"environment",
"applied",
"resources",
"pageInfo",
),
),
)
self.resource_details_fetcher = ResourceDetailsFetcher()
self.lineage_fetcher = LineageFetcher()
self.model_performance_fetcher = ModelPerformanceFetcher(
resource_details_fetcher=self.resource_details_fetcher,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_mart_models"),
title="Get Mart Models",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_mart_models(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
mart_models = await context.models_fetcher.fetch_models(
model_filter={"modelingLayer": "marts"},
config=config,
)
return [m for m in mart_models if m["name"] != "metricflow_time_spine"]
@dbt_mcp_tool(
description=get_prompt("discovery/get_all_models"),
title="Get All Models",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_all_models(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
) -> list[dict]:
# TODO: push code into fetchers
config = await context.config_provider.get_config(project_id=project_id)
return await context.models_fetcher.fetch_models(config=config)
@dbt_mcp_tool(
description=get_prompt("discovery/get_model_details"),
title="Get Model Details",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_model_details(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.resource_details_fetcher.fetch_details(
resource_type=AppliedResourceType.MODEL,
unique_id=unique_id,
name=name,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_model_health"),
title="Get Model Health",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_model_health(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.models_fetcher.fetch_model_health(
model_name=name,
unique_id=unique_id,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_model_performance"),
title="Get Model Performance",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_model_performance(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
num_runs: int = Field(
default=1,
description=MODEL_PERF_NUM_RUNS,
ge=1,
le=100,
),
include_tests: bool = Field(
default=False,
description=MODEL_PERF_INCLUDE_TESTS,
),
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.model_performance_fetcher.fetch_performance(
name=name,
unique_id=unique_id,
num_runs=num_runs,
include_tests=include_tests,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_lineage"),
title="Get Lineage",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_lineage(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
unique_id: str = UNIQUE_ID_REQUIRED_FIELD,
types: list[LineageResourceType] | None = TYPES_FIELD,
depth: int = DEPTH_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.lineage_fetcher.fetch_lineage(
unique_id=unique_id, types=types, depth=depth, config=config
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_exposures"),
title="Get Exposures",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_exposures(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.exposures_fetcher.fetch_exposures(config=config)
@dbt_mcp_tool(
description=get_prompt("discovery/get_exposure_details"),
title="Get Exposure Details",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_exposure_details(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.resource_details_fetcher.fetch_details(
resource_type=AppliedResourceType.EXPOSURE,
unique_id=unique_id,
name=name,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_all_sources"),
title="Get All Sources",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_all_sources(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
source_names: Annotated[
list[str] | None, Field(description=SOURCE_NAMES_FILTER)
] = None,
unique_ids: Annotated[
list[str] | None, Field(description=SOURCE_UNIQUE_IDS_FILTER)
] = None,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.sources_fetcher.fetch_sources(
source_names, unique_ids, config=config
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_source_details"),
title="Get Source Details",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_source_details(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.resource_details_fetcher.fetch_details(
resource_type=AppliedResourceType.SOURCE,
unique_id=unique_id,
name=name,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_all_macros"),
title="Get All Macros",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_all_macros(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
package_names: Annotated[
list[str] | None, Field(description=MACRO_PACKAGE_NAMES)
] = None,
return_package_names_only: Annotated[
bool, Field(description=MACRO_RETURN_PACKAGE_NAMES_ONLY)
] = False,
include_default_dbt_packages: Annotated[
bool, Field(description=MACRO_INCLUDE_DEFAULT_DBT_PACKAGES)
] = False,
) -> list[dict] | list[str]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.macros_fetcher.fetch_macros(
package_names=package_names,
return_package_names_only=return_package_names_only,
include_default_dbt_packages=include_default_dbt_packages,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_macro_details"),
title="Get Macro Details",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_macro_details(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.resource_details_fetcher.fetch_details(
resource_type=AppliedResourceType.MACRO,
unique_id=unique_id,
name=name,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_seed_details"),
title="Get Seed Details",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_seed_details(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.resource_details_fetcher.fetch_details(
resource_type=AppliedResourceType.SEED,
unique_id=unique_id,
name=name,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_semantic_model_details"),
title="Get Semantic Model Details",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_semantic_model_details(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.resource_details_fetcher.fetch_details(
resource_type=AppliedResourceType.SEMANTIC_MODEL,
unique_id=unique_id,
name=name,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_snapshot_details"),
title="Get Snapshot Details",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_snapshot_details(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.resource_details_fetcher.fetch_details(
resource_type=AppliedResourceType.SNAPSHOT,
unique_id=unique_id,
name=name,
config=config,
)
@dbt_mcp_tool(
description=get_prompt("discovery/get_test_details"),
title="Get Test Details",
read_only_hint=True,
destructive_hint=False,
idempotent_hint=True,
)
async def get_test_details(
context: MultiProjectDiscoveryToolContext,
project_id: Annotated[int, Field(description=DISCOVERY_PROJECT_ID_DESCRIPTION)],
name: str | None = NAME_FIELD,
unique_id: str | None = UNIQUE_ID_FIELD,
) -> list[dict]:
config = await context.config_provider.get_config(project_id=project_id)
return await context.resource_details_fetcher.fetch_details(
resource_type=AppliedResourceType.TEST,
unique_id=unique_id,
name=name,
config=config,
)
MULTIPROJECT_DISCOVERY_TOOLS = [
get_mart_models,
get_all_models,
get_model_details,
get_model_health,
get_model_performance,
get_lineage,
get_exposures,
get_exposure_details,
get_all_sources,
get_source_details,
get_all_macros,
get_macro_details,
get_seed_details,
get_semantic_model_details,
get_snapshot_details,
get_test_details,
]
def register_multiproject_discovery_tools(
dbt_mcp: FastMCP,
config_provider: MultiProjectDiscoveryConfigProvider,
*,
disabled_tools: set[ToolName],
enabled_tools: set[ToolName] | None,
enabled_toolsets: set[Toolset],
disabled_toolsets: set[Toolset],
) -> None:
def bind_context() -> MultiProjectDiscoveryToolContext:
return MultiProjectDiscoveryToolContext(
config_provider=config_provider,
)
register_tools(
dbt_mcp,
tool_definitions=[
tool.adapt_context(bind_context) for tool in MULTIPROJECT_DISCOVERY_TOOLS
],
disabled_tools=disabled_tools,
enabled_tools=enabled_tools,
enabled_toolsets=enabled_toolsets,
disabled_toolsets=disabled_toolsets,
)