-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmodels.py
More file actions
405 lines (311 loc) · 15.9 KB
/
models.py
File metadata and controls
405 lines (311 loc) · 15.9 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
"""Vendored API models for mcp-tef CLI.
This module contains minimal Pydantic models for interacting with the mcp-tef API.
These models are vendored (copied) from the main mcp-tef package to avoid
requiring the full server as a dependency.
"""
from datetime import datetime
from typing import Any
from pydantic import BaseModel, Field, field_validator, model_validator
__all__ = [
"HealthResponse",
"ServerInfo",
"EvaluationDimensionResult",
"EvaluationResult",
"ToolQualityResult",
"ToolQualityResponse",
# Test case models
"MCPServerConfig",
"TestCaseCreate",
"TestCaseResponse",
"PaginatedTestCaseResponse",
"ToolDefinition",
# Test run models
"ModelSettingsCreate",
"ModelSettingsResponse",
"TestRunExecuteRequest",
"ToolEnrichedResponse",
"TestRunResponse",
"PaginatedTestRunResponse",
# Similarity models
"ToolPair",
"SimilarityMatrixResponse",
"DifferentiationIssue",
"RecommendationItem",
"DifferentiationRecommendation",
"DifferentiationRecommendationResponse",
"OverlapMatrixResponse",
"SimilarityAnalysisResponse",
]
class HealthResponse(BaseModel):
"""Response schema for health check endpoint."""
status: str = Field(..., description="Health status (healthy/unhealthy)")
class ServerInfo(BaseModel):
"""Response schema for server information endpoint."""
name: str = Field(..., description="Service name")
version: str = Field(..., description="Service version")
status: str = Field(..., description="Service status")
class EvaluationDimensionResult(BaseModel):
"""Result of evaluation along a single dimension (clarity, completeness, conciseness)."""
score: int = Field(..., description="A score from 1 to 10 for this dimension")
explanation: str = Field(..., description="Explanation of the reasoning for the given score")
class EvaluationResult(BaseModel):
"""Output model for the tool description evaluation."""
clarity: EvaluationDimensionResult = Field(
..., description="Evaluation of the clarity of the tool description"
)
completeness: EvaluationDimensionResult = Field(
..., description="Evaluation of the completeness of the tool description"
)
conciseness: EvaluationDimensionResult = Field(
..., description="Evaluation of the conciseness of the tool description"
)
suggested_description: str | None = Field(
default=None,
description="Suggested tool description (optional)",
)
class ToolQualityResult(BaseModel):
"""Result of quality evaluation for a single tool."""
tool_name: str = Field(..., description="Tool name")
tool_description: str = Field(..., description="Original tool description")
evaluation_result: EvaluationResult = Field(..., description="Result of the tool evaluation")
class ToolQualityResponse(BaseModel):
"""Response from the tool quality evaluation endpoint."""
results: list[ToolQualityResult] = Field(..., description="Tool quality results")
errors: list[str] | None = Field(
default=None, description="Errors encountered during evaluation"
)
# =============================================================================
# Test Case Models
# =============================================================================
class MCPServerConfig(BaseModel):
"""MCP server configuration with transport type.
Note: This model is vendored (copied) from src/mcp_tef/models/schemas.py
to avoid requiring the full server package as a CLI dependency.
Keep in sync with the main model for consistency.
"""
url: str = Field(
...,
min_length=1,
pattern=r"^https?://",
description="Server URL (must be http or https)",
)
transport: str = Field(
default="streamable-http",
pattern=r"^(sse|streamable-http)$",
description="Transport type: 'sse' or 'streamable-http'",
)
class ToolDefinition(BaseModel):
"""Definition of a tool available from an MCP server."""
name: str = Field(..., description="Tool name")
description: str | None = Field(default=None, description="Tool description")
class TestCaseCreate(BaseModel):
"""Request model for creating a test case."""
name: str = Field(..., description="Descriptive name for the test case")
query: str = Field(..., description="User query to evaluate")
expected_mcp_server_url: str | None = Field(
default=None, description="Expected MCP server URL (null for negative tests)"
)
expected_tool_name: str | None = Field(
default=None, description="Expected tool name (null for negative tests)"
)
expected_parameters: dict | None = Field(
default=None, description="Expected parameters as JSON object"
)
available_mcp_servers: list[MCPServerConfig] = Field(
..., description="MCP server configurations available for selection", min_length=1
)
@field_validator("available_mcp_servers", mode="before")
@classmethod
def normalize_available_mcp_servers(cls, v: Any) -> list[Any]:
"""Convert string URLs to MCPServerConfig objects for convenience."""
if not isinstance(v, list):
return v
normalized = []
for item in v:
if isinstance(item, str):
# Convert string URL to MCPServerConfig dict
normalized.append({"url": item, "transport": "streamable-http"})
elif isinstance(item, dict):
# Already a dict, pass through (will be validated as MCPServerConfig)
normalized.append(item)
else:
# Already a MCPServerConfig object or other type
normalized.append(item)
return normalized
@model_validator(mode="after")
def validate_expected_tool_fields(self) -> "TestCaseCreate":
"""Validate cross-field constraints for expected tool configuration."""
# expected_server and expected_tool must both be present or both absent
if (self.expected_mcp_server_url is None) != (self.expected_tool_name is None):
raise ValueError(
"expected_mcp_server_url and expected_tool_name must both be provided "
"or both omitted"
)
# expected_server must be in available_mcp_servers
if self.expected_mcp_server_url:
available_urls = [server.url for server in self.available_mcp_servers]
if self.expected_mcp_server_url not in available_urls:
raise ValueError(
f"expected_mcp_server_url '{self.expected_mcp_server_url}' "
"must be in available_mcp_servers"
)
# expected_parameters requires expected_tool_name
if self.expected_parameters and not self.expected_tool_name:
raise ValueError("expected_parameters requires expected_tool_name to be set")
return self
class TestCaseResponse(BaseModel):
"""Response model for test case."""
id: str = Field(..., description="Test case UUID")
name: str = Field(..., description="Test case name")
query: str = Field(..., description="User query")
expected_mcp_server_url: str | None = Field(default=None, description="Expected MCP server URL")
expected_tool_name: str | None = Field(default=None, description="Expected tool name")
expected_parameters: dict | None = Field(default=None, description="Expected parameters")
available_mcp_servers: list[MCPServerConfig] = Field(
..., description="Available MCP server configurations"
)
available_tools: dict[str, list[ToolDefinition]] | None = Field(
default=None, description="Available tools by server URL"
)
created_at: datetime = Field(..., description="Creation timestamp")
updated_at: datetime = Field(..., description="Last update timestamp")
@field_validator("available_mcp_servers", mode="before")
@classmethod
def normalize_available_mcp_servers(cls, v: Any) -> list[Any]:
"""Convert string URLs to MCPServerConfig objects for convenience."""
if not isinstance(v, list):
return v
normalized = []
for item in v:
if isinstance(item, str):
# Convert string URL to MCPServerConfig dict
normalized.append({"url": item, "transport": "streamable-http"})
elif isinstance(item, dict):
# Already a dict, pass through (will be validated as MCPServerConfig)
normalized.append(item)
else:
# Already a MCPServerConfig object or other type
normalized.append(item)
return normalized
class PaginatedTestCaseResponse(BaseModel):
"""Paginated test case response."""
items: list[TestCaseResponse] = Field(..., description="Test cases")
total: int = Field(..., description="Total number of test cases")
offset: int = Field(..., description="Offset for pagination")
limit: int = Field(..., description="Limit for pagination")
# =============================================================================
# Test Run Models
# =============================================================================
class ModelSettingsCreate(BaseModel):
"""Model configuration for test execution."""
provider: str = Field(..., description="LLM provider name")
model: str = Field(..., description="Model identifier")
timeout: int = Field(default=30, description="Model timeout in seconds")
temperature: float = Field(default=0.4, description="Model temperature")
max_retries: int = Field(default=3, description="Maximum retries on failure")
base_url: str | None = Field(default=None, description="Custom base URL")
class ModelSettingsResponse(BaseModel):
"""Model settings response from API."""
id: str | None = Field(default=None, description="Model settings ID")
provider: str = Field(..., description="LLM provider name")
model: str = Field(..., description="Model identifier")
timeout: int = Field(default=30, description="Model timeout in seconds")
temperature: float = Field(default=0.4, description="Model temperature")
max_retries: int = Field(default=3, description="Maximum retries on failure")
base_url: str | None = Field(default=None, description="Custom base URL")
class TestRunExecuteRequest(BaseModel):
"""Request model for executing a test run."""
model_settings: ModelSettingsCreate = Field(..., description="Model configuration")
class ToolEnrichedResponse(BaseModel):
"""Tool information with parameters."""
id: str | None = Field(default=None, description="Tool ID")
name: str = Field(..., description="Tool name")
mcp_server_url: str = Field(..., description="MCP server URL")
parameters: dict | None = Field(default=None, description="Tool parameters")
class TestRunResponse(BaseModel):
"""Response model for test run."""
id: str = Field(..., description="Test run UUID")
test_case_id: str = Field(..., description="Associated test case ID")
model_settings: ModelSettingsResponse | None = Field(
default=None, description="Model settings used"
)
status: str = Field(..., description="Status: pending, running, completed, failed")
llm_response_raw: str | None = Field(default=None, description="Raw LLM response")
selected_tool: ToolEnrichedResponse | None = Field(
default=None, description="Tool selected by LLM"
)
expected_tool: ToolEnrichedResponse | None = Field(
default=None, description="Expected tool from test case"
)
extracted_parameters: dict | None = Field(
default=None, description="Parameters extracted from LLM response"
)
parameter_correctness: float | None = Field(
default=None, description="Parameter accuracy score"
)
llm_confidence: str | None = Field(default=None, description="LLM confidence level: high, low")
confidence_score: str | None = Field(
default=None, description="Confidence score: robust, needs_clarity, misleading"
)
classification: str | None = Field(default=None, description="Classification: TP, FP, TN, FN")
execution_time_ms: int | None = Field(default=None, description="Execution time in ms")
error_message: str | None = Field(default=None, description="Error message if failed")
created_at: datetime = Field(..., description="Creation timestamp")
completed_at: datetime | None = Field(default=None, description="Completion timestamp")
class PaginatedTestRunResponse(BaseModel):
"""Paginated test run response."""
items: list[TestRunResponse] = Field(..., description="List of test runs")
total: int = Field(..., description="Total number of test runs")
offset: int = Field(..., description="Offset for pagination")
limit: int = Field(..., description="Limit for pagination")
# =============================================================================
# Similarity Models
# =============================================================================
class ToolPair(BaseModel):
"""Tool pair with similarity score."""
tool_a_id: str = Field(..., description="First tool ID")
tool_b_id: str = Field(..., description="Second tool ID")
similarity_score: float = Field(..., ge=0.0, le=1.0, description="Similarity score")
class SimilarityMatrixResponse(BaseModel):
"""Response for similarity matrix."""
tool_ids: list[str] = Field(..., description="Ordered list of tool IDs")
matrix: list[list[float]] = Field(..., description="2D similarity matrix")
threshold: float = Field(..., description="Threshold used for flagging")
flagged_pairs: list[ToolPair] = Field(..., description="Pairs exceeding threshold")
generated_at: str = Field(..., description="Generation timestamp (ISO 8601)")
class DifferentiationIssue(BaseModel):
"""Issue identified in tool pair analysis."""
issue_type: str = Field(..., description="Issue type identifier")
description: str = Field(..., description="Human-readable description")
tool_a_id: str = Field(..., description="First tool ID")
tool_b_id: str = Field(..., description="Second tool ID")
evidence: dict[str, Any] = Field(default_factory=dict, description="Supporting evidence")
class RecommendationItem(BaseModel):
"""Individual actionable recommendation."""
issue: str = Field(..., description="Issue this addresses")
tool_id: str | None = Field(None, description="Tool to modify")
recommendation: str = Field(..., description="Specific action")
rationale: str = Field(..., description="Why this matters")
priority: str = Field(..., description="Priority: high, medium, low")
revised_description: str | None = Field(None, description="Improved description")
apply_commands: list[str] | None = Field(None, description="Commands to apply")
class DifferentiationRecommendation(BaseModel):
"""Recommendation for improving tool differentiation."""
tool_pair: list[str] = Field(..., description="[tool_a_id, tool_b_id]")
similarity_score: float = Field(..., description="Similarity score")
issues: list[DifferentiationIssue] = Field(..., description="Identified issues")
recommendations: list[RecommendationItem] = Field(..., description="Recommendations")
class DifferentiationRecommendationResponse(DifferentiationRecommendation):
"""Response for recommendations endpoint."""
generated_at: str = Field(..., description="Generation timestamp")
class OverlapMatrixResponse(BaseModel):
"""Response for capability overlap matrix."""
tool_ids: list[str] = Field(..., description="Ordered list of tool IDs")
matrix: list[list[float]] = Field(..., description="2D overlap matrix")
dimensions: dict[str, float] = Field(..., description="Dimension weights")
generated_at: str = Field(..., description="Generation timestamp")
class SimilarityAnalysisResponse(SimilarityMatrixResponse):
"""Response for full similarity analysis."""
recommendations: list[DifferentiationRecommendation] | None = Field(
None, description="Recommendations if requested"
)