Skip to main content
Glama
crisschan

MCP-Allure

by crisschan
OverviewSchemaRelated ServersScoreDiscussions
Python
Hybrid

get_allure_report

Extract and convert Allure test reports into JSON format for AI analysis, enabling detailed insights into test failures and potential solutions.

Instructions

read allure report and return json data

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
results_dirYes

Implementation Reference

  • mcp-allure-server.py:11-19 (handler)
    The handler function that reads an Allure report from the given results_dir, parses it using AllureSuiteParser, and returns the data as a formatted JSON string. Handles exceptions by returning the error message.
    async def get_allure_report(results_dir: str) -> str:
    """
    read allure report and return json data
    """
    try:
        parser = AllureSuiteParser(results_dir)
        return json.dumps(parser.parse(), indent=2, ensure_ascii=False)
    except Exception as e:
        return str(e)
  • mcp-allure-server.py:10-10 (registration)
    The @mcp.tool() decorator registers the get_allure_report function as an MCP tool.
    @mcp.tool()

Tool Definition Quality

C2.4/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions reading and returning JSON data, but fails to disclose critical traits: whether this is a read-only operation (implied by 'read' but not explicit), potential side effects (e.g., file access permissions), error handling, or performance aspects (e.g., large report processing). The description adds minimal value beyond the basic action.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is very concise—a single sentence with no wasted words—and front-loaded with the core action. However, it is under-specified rather than efficiently concise; it could benefit from slightly more detail without losing brevity. It earns a high score for structure but loses a point due to under-specification.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (a tool to read and parse reports), lack of annotations, 0% schema coverage, and no output schema, the description is incomplete. It does not explain the return format beyond 'json data' (e.g., structure, keys), error conditions, or dependencies. For a tool with one parameter and no structured support, more context is needed to be adequately helpful.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, with 1 parameter ('results_dir') undocumented in the schema. The description does not compensate by explaining what 'results_dir' means (e.g., path to Allure results directory, expected format), its role in reading the report, or any constraints. This leaves the parameter's semantics unclear, failing to add meaning beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states the tool 'read[s] allure report and return[s] json data', which provides a basic verb+resource combination ('read allure report') and outcome ('return json data'). However, it's vague about what constitutes an 'allure report' (e.g., test results, specific file format) and doesn't differentiate from siblings (though none exist). It avoids tautology by not merely restating the name, but lacks specificity.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool—there are no alternatives mentioned (sibling tools are none), no context about prerequisites (e.g., requires an existing report directory), and no exclusions or comparisons. The description implies usage for reading reports but offers no further direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/crisschan/mcp-allure'

If you have feedback or need assistance with the MCP directory API, please join our Discord server