allure-reader-mcp
v1.0.1
Published
MCP server that reads Allure test results — failure stacktraces, step details, screenshots and DOM snapshots — from a local directory or a Jenkins build artifact.
Maintainers
Readme
allure-reader-mcp
MCP server that reads Allure test results and hands the useful parts to an AI agent: failure stacktraces, step-level detail, screenshots and DOM snapshots. Results can come from a local directory or straight from a Jenkins build's archived artifacts.
Screenshots matter here. A step marked as passed in Allure can still have returned the wrong thing, so the server exposes the actual page state at failure time rather than trusting the step log.
Install
No clone needed — npx will fetch it:
npx -y allure-reader-mcpOr install it globally:
npm install -g allure-reader-mcpConfigure
Add it to your MCP client config. For Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):
{
"mcpServers": {
"allure-reader": {
"command": "npx",
"args": ["-y", "allure-reader-mcp"],
"env": {
"ALLURE_RESULTS_DIR": "/path/to/your/project/target"
}
}
}
}For Claude Code:
claude mcp add allure-reader --env ALLURE_RESULTS_DIR=/path/to/your/project/target -- npx -y allure-reader-mcpEnvironment variables
| Variable | Required | Purpose |
| --- | --- | --- |
| ALLURE_RESULTS_DIR | no | Where to look for results. The server searches for allure-results/ under this path; it also falls back to target/allure-results/ relative to the working directory. |
| JENKINS_URL | for Jenkins use | Your Jenkins view or folder URL, without the /job/<Name> part — e.g. https://jenkins.example.com/view/My-View. No default; Jenkins tools error out until it is set. |
| JENKINS_USER | for Jenkins use | Jenkins username or email. |
| JENKINS_TOKEN | for Jenkins use | Jenkins API token (Jenkins → Your Profile → Configure → API Token). |
The results directory can also be passed as --results-dir=/path/to/target, or switched at runtime with the allure_set_dir tool.
Keep tokens out of version control — put them in your local MCP client config, not in a committed file.
Tools
| Tool | What it does |
| --- | --- |
| allure_fetch_build | Downloads allure-results/ from a Jenkins build artifact (job + build number, or latest) and reads from it. |
| allure_set_dir | Points the server at a different results directory for the rest of the session. |
| allure_summary | Pass/fail counts plus the list of failing tests. |
| allure_failure_details | Stacktrace, step breakdown and diagnostics for a failure. |
| allure_read_attachment | Reads a text attachment (logs, DOM snapshots, request/response dumps). |
| allure_view_screenshot | Returns a screenshot attachment as an image the model can actually look at. |
Requirements
Node.js 18 or newer.
License
MIT
