Skip to content
This repository was archived by the owner on Sep 4, 2025. It is now read-only.

Commit 8b5af3c

Browse files
authored
Updated scoring metrics and renamed utility for evaluating tool descriptions (#965)
* Updated scoring metrics and results * Renamed the utility to ToolDescriptionEvaluator * Added licensing header to .cs files
1 parent 556c3f4 commit 8b5af3c

25 files changed

+12233
-7194
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
- [ ] Updated `README.md` documentation
2121
- [ ] Updated command list in `/docs/azmcp-commands.md`
2222
- [ ] Updated test prompts in `/e2eTests/e2eTestPrompts.md`
23-
- [ ] For new or modified tool descriptions, ran the `eng/tools/ToolDescriptionConfidenceScore` tool and obtained a result >= 0.4
23+
- [ ] For new or modified tool descriptions, ran the `eng/tools/ToolDescriptionEvaluator` tool and obtained a result >= 0.4
2424
- [ ] 👉 For Community (non-Azure team member) PRs:
2525
- [ ] **Security review**: Reviewed code for security vulnerabilities, malicious code, or suspicious activities before running tests (`crypto mining, spam, data exfiltration, etc.`)
2626
- [ ] **Manual tests run**: added comment `/azp run azure - mcp` to run *Live Test Pipeline*

‎CONTRIBUTING.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ The project is organized as follows:
144144
- Include tests in the `/tests` folder
145145
- Ensure all tests pass
146146
- Follow code style requirements
147-
- Run the `eng/tools/ToolDescriptionConfidenceScore` tool for the new tool description and ensure a result >= 0.4 is achieved
147+
- Run the `eng/tools/ToolDescriptionEvaluator` tool for the new tool description and ensure a result >= 0.4 is achieved
148148

149149
## Testing
150150

‎docs/new-command.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1381,12 +1381,11 @@ catch (Exception ex)
13811381
- **Maintain alphabetical sorting in e2eTestPrompts.md**: Insert new test prompts in correct alphabetical position by Tool Name within each service section
13821382

13831383
5. Tool Description Quality Validation:
1384-
- Test your command descriptions for quality using the validation tool before submitting:
1384+
- Test your command descriptions for quality using the validation tool located at `eng/tools/ToolDescriptionEvaluator` before submitting:
13851385

13861386
- **Single prompt validation** (test one description against one prompt):
13871387

13881388
```bash
1389-
cd eng/tools/ToolDescriptionConfidenceScore
13901389
dotnet run -- --validate --tool-description "Your command description here" --prompt "typical user request"
13911390
```
13921391

@@ -1411,7 +1410,7 @@ catch (Exception ex)
14111410
dotnet run -- --prompts-file my-prompts.json
14121411
14131412
# Tools:
1414-
# Use JSON format (same as eng/tools/ToolDescriptionConfidenceScore/tools.json):
1413+
# Use JSON format (same as eng/tools/ToolDescriptionEvaluator/tools.json):
14151414
dotnet run -- --tools-file my-tools.json
14161415
14171416
# Combine both:
@@ -1448,7 +1447,7 @@ catch (Exception ex)
14481447
```
14491448

14501449
- Custom tools file format:
1451-
- Use the JSON format returned by calling the server command `azmcp-tools-list` or found in `eng/tools/ToolDescriptionConfidenceScore/tools.json`.
1450+
- Use the JSON format returned by calling the server command `azmcp-tools-list` or found in `eng/tools/ToolDescriptionEvaluator/tools.json`.
14521451

14531452
6. Live Test Infrastructure:
14541453
- Use minimal resource configurations for cost efficiency

‎eng/scripts/Test-ToolSelection.ps1‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ $RepoRoot = $RepoRoot.Path.Replace('\', '/')
6060

6161
Push-Location $RepoRoot
6262
try {
63-
$toolSelectionPath = "$RepoRoot/eng/tools/ToolDescriptionConfidenceScore"
63+
$toolSelectionPath = "$RepoRoot/eng/tools/ToolDescriptionEvaluator"
6464

6565
if (-not (Test-Path $toolSelectionPath)) {
6666
Write-Host "⏭️ Tool selection test not found at $toolSelectionPath - skipping"

‎eng/tools/ToolDescriptionConfidenceScore/Models/SuccessRateMetrics.cs‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)