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

Commit 93c50c4

Browse files
authored
Move e2etestprompts.md to docs (#992)
1 parent 3ca24b3 commit 93c50c4

File tree

8 files changed

+13
-13
lines changed

8 files changed

+13
-13
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
- [ ] **One tool per PR**: This PR adds or modifies only one MCP tool for faster review cycles
2020
- [ ] Updated `README.md` documentation
2121
- [ ] Updated command list in `/docs/azmcp-commands.md`
22-
- [ ] Updated test prompts in `/e2eTests/e2eTestPrompts.md`
22+
- [ ] Updated test prompts in `/docs/e2eTestPrompts.md`
2323
- [ ] 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.`)

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ The project is organized as follows:
134134

135135
5. **Update documentation**:
136136
- Add the new command to [/docs/azmcp-commands.md](https://github.com/Azure/azure-mcp/blob/main/docs/azmcp-commands.md)
137-
- Add test prompts for the new command in [/e2eTests/e2eTestPrompts.md](https://github.com/Azure/azure-mcp/blob/main/e2eTests/e2eTestPrompts.md)
137+
- Add test prompts for the new command in [/docs/e2eTestPrompts.md](https://github.com/Azure/azure-mcp/blob/main/docs/e2eTestPrompts.md)
138138
- Update [README.md](https://github.com/Azure/azure-mcp/blob/main/README.md) to mention the new command
139139

140140
6. **Add CODEOWNERS entry** in [CODEOWNERS](https://github.com/Azure/azure-mcp/blob/main/.github/CODEOWNERS) [(example)](https://github.com/Azure/azure-mcp/commit/08f73efe826d5d47c0f93be5ed9e614740e82091)
@@ -167,7 +167,7 @@ Requirements:
167167

168168
### End-to-end Tests
169169

170-
End-to-end tests are performed manually. Command authors must thoroughly test each command to ensure correct tool invocation and results. At least one prompt per tool is required and should be added to `/e2eTests/e2eTestPrompts.md`.
170+
End-to-end tests are performed manually. Command authors must thoroughly test each command to ensure correct tool invocation and results. At least one prompt per tool is required and should be added to `/docs/e2eTestPrompts.md`.
171171

172172
### Testing Local Build with VS Code
173173

File renamed without changes.

‎docs/new-command.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1403,7 +1403,7 @@ catch (Exception ex)
14031403

14041404
```bash
14051405
# Prompts:
1406-
# Use markdown format (same as e2eTests/e2eTestPrompts.md):
1406+
# Use markdown format (same as docs/e2eTestPrompts.md):
14071407
dotnet run -- --prompts-file my-prompts.md
14081408
14091409
# Use JSON format:
@@ -1426,7 +1426,7 @@ catch (Exception ex)
14261426
- If validation shows POOR results or a confidence score of < 0.4, refine your description and test again
14271427

14281428
- Custom prompts file formats:
1429-
- **Markdown format**: Use same table format as `e2eTests/e2eTestPrompts.md`:
1429+
- **Markdown format**: Use same table format as `docs/e2eTestPrompts.md`:
14301430

14311431
```markdown
14321432
| Tool Name | Test Prompt |
@@ -1781,7 +1781,7 @@ Before submitting:
17811781
- [ ] **docs/azmcp-commands.md**: Add command documentation with description, syntax, parameters, and examples
17821782
- [ ] **README.md**: Update the supported services table and add example prompts demonstrating the new command(s) in the appropriate area section
17831783
- [ ] **eng/vscode/README.md**: Update the VSIX README with new service area (if applicable) and add sample prompts to showcase new command capabilities
1784-
- [ ] **e2eTests/e2eTestPrompts.md**: Add test prompts for end-to-end validation of the new command(s)
1784+
- [ ] **docs/e2eTestPrompts.md**: Add test prompts for end-to-end validation of the new command(s)
17851785
- [ ] **.github/CODEOWNERS**: Add new area to CODEOWNERS file for proper ownership and review assignments
17861786
17871787
**Documentation Standards**:

‎eng/scripts/Test-ToolSelection.ps1‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ try {
7171
try {
7272
# Check if we have the required sources for dynamic loading
7373
$hasSourceCode = Test-Path "$RepoRoot/src"
74-
$hasMarkdownPrompts = Test-Path "$RepoRoot/e2eTests/e2eTestPrompts.md"
74+
$hasMarkdownPrompts = Test-Path "$RepoRoot/docs/e2eTestPrompts.md"
7575

7676
# Check if we have fallback test data files
7777
$hasToolsData = Test-Path "tools.json"
@@ -154,7 +154,7 @@ try {
154154
if ($resolvedPromptsFile) {
155155
Write-Host "💬 Prompts File: $resolvedPromptsFile"
156156
} else {
157-
Write-Host "💬 Prompts Source: $RepoRoot/e2eTests/e2eTestPrompts.md"
157+
Write-Host "💬 Prompts Source: $RepoRoot/docs/e2eTestPrompts.md"
158158
}
159159
Write-Host "📄 Output Format: $(if ($OutputMarkdown) { 'Markdown' } else { 'Plain Text' })"
160160
}

‎eng/tools/ToolDescriptionEvaluator/Program.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ static async Task Main(string[] args)
257257
{
258258
// Use default fallback logic
259259

260-
var defaultPromptsPath = Path.Combine(repoRoot, "e2eTests", "e2eTestPrompts.md");
260+
var defaultPromptsPath = Path.Combine(repoRoot, "docs", "e2eTestPrompts.md");
261261
toolNameAndPrompts = await LoadPromptsFromMarkdownAsync(defaultPromptsPath, isCiMode);
262262

263263
// Save parsed prompts to prompts.json for future use

‎eng/tools/ToolDescriptionEvaluator/Quickstart.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Or copy `.env.example` to `.env` and fill in your credentials.
3232
### Typical Workflow
3333

3434
1. Add or update a tool description in the project
35-
2. Add test prompts for your tool to `/e2eTests/e2eTestPrompts.md`
35+
2. Add test prompts for your tool to `/docs/e2eTestPrompts.md`
3636
3. Run the analyzer using PowerShell
3737

3838
```pwsh

‎eng/tools/ToolDescriptionEvaluator/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is a testing and analysis tool that evaluates how well Azure MCP Server too
77
The application:
88

99
1. Loads tool definitions from the Azure MCP Server (dynamically or from JSON files)
10-
1. Loads test prompts from markdown or JSON files (default: `e2eTests/e2eTestPrompts.md`)
10+
1. Loads test prompts from markdown or JSON files (default: `docs/e2eTestPrompts.md`)
1111
1. Creates embeddings for tool descriptions using Azure OpenAI's `text-embedding-3-large` model
1212
1. Tests prompt-to-tool matching using vector similarity search with cosine similarity
1313
1. Generates confidence scores and analysis reports to identify gaps in tool selection accuracy
@@ -83,7 +83,7 @@ The tool can load data from multiple sources:
8383

8484
### Test Prompts
8585

86-
- **Markdown format** (default): Uses `../../../e2eTests/e2eTestPrompts.md`
86+
- **Markdown format** (default): Uses `../../../docs/e2eTestPrompts.md`
8787
- **JSON format**: Uses `prompts.json` or custom file specified with `--prompts-file`
8888
- **Custom files**: Supports both `.md` and `.json` formats
8989

@@ -191,7 +191,7 @@ The tool provides several key metrics:
191191

192192
#### Markdown Format (Default)
193193

194-
The tool reads from `e2eTests/e2eTestPrompts.md` which contains tables like:
194+
The tool reads from `docs/e2eTestPrompts.md` which contains tables like:
195195

196196
```markdown
197197
## Azure Storage

0 commit comments

Comments
 (0)