ROX-32888: Add evaluation docs and script to update it#99
Merged
Conversation
❌ 2 Tests Failed:
View the full list of 2 ❄️ flaky test(s)
To view more test analytics, go to the Test Analytics Dashboard |
E2E Test ResultsCommit: b8366e6 |
janisz
approved these changes
Apr 1, 2026
Contributor
janisz
left a comment
There was a problem hiding this comment.
Maybe we can run it on CI with label or manuall job dispach?
52677d3 to
b8366e6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Create standardized documentation for LLM model evaluation results with the StackRox MCP server (
docs/model-evaluation.md). The document covers evaluation methodology using the mcpchecker framework, per-model results tables with assertion pass/fail and token usage, and instructions for running evaluations and updating the documentation.A companion automation script (
scripts/update-model-evaluation.sh) parses mcpchecker JSON output usingjqand generates/updates model result sections in the documentation using HTML comment markers for idempotent block replacement.New files:
docs/model-evaluation.md— Evaluation results and methodology documentationscripts/update-model-evaluation.sh— Script to auto-update docs from mcpchecker JSON outputValidation
shellcheck scripts/update-model-evaluation.shpassesmake shell-lintpassesAI-assisted development prompts
This PR was developed with AI assistance. Below are the prompts used: