Skip to content

Commit 4b9f314

Browse files
Merge pull request #11 from healenium/feature/EPMHLM-513
EPMHLM-513 update Readme
2 parents d0c2df0 + 9e74764 commit 4b9f314

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,24 @@
88
The Healenium MCP Server is a bridge between your Healenium instance and AI chat assistants (such as Claude Desktop, GitHub Copilot, Cursor). In simple terms, it lets you ask questions in plain English about your test runs and get answers directly from Healenium. It follows the official [MCP](https://modelcontextprotocol.io/docs/getting-started/intro) guidelines.
99

1010
## Installation
11-
...
11+
12+
### Achieve MCP Server docker image
13+
14+
Pull docker image from the Healenium registery:
15+
16+
```bash
17+
docker pull healenium/healenium-mcp-server:1.0.0
18+
```
19+
20+
Or build image locally (Go 1.24.1 or later is required)
21+
22+
```bash
23+
docker build -t healenium-mcp-server .
24+
```
25+
26+
### AI Assistant config
27+
28+
```json
1229

1330
{
1431
    "mcpServers":
@@ -32,6 +49,22 @@ The Healenium MCP Server is a bridge between your Healenium instance and AI chat
3249
        }
3350
    }
3451
}
52+
```
53+
54+
### Healenium MCP Tools
55+
56+
The server registers these tools:
57+
58+
| Tool | Purpose |
59+
|------|---------|
60+
| `getLastReport` | Retrieves the most recent healing report JSON (`GET /healenium/report/data`), including healing attempts; response typically includes `reportLinks` for the report list. |
61+
| `getReportById` | Retrieves one report by 32-char hex `uid` (`GET /healenium/report/data/{uid}`). |
62+
| `getSelectorByParameters` | Retrieves the reference (original) selector for an element; requires `locator`, `command` (`findElement` / `findElements`), `url`; optional `className`, `methodName` (`GET /healenium`). |
63+
| `getAllSelectors` | Lists all stored selector records (locators, class/method names, commands, URLs) (`GET /healenium/selector/all`). |
64+
| `updateHealingResult` | Sets healing success/failure for a healing attempt (`healingResultId`, `successHealing`) (`POST /healenium/healing/success`). |
65+
| `saveSelectorPath` | Saves selector path data: associates a selector `id` (32-char hex) with `data` records (`healingResultId`, `declaringClass`) (`POST /healenium/selector/save/path`). |
66+
67+
You can confirm details in internal/mcp_handlers/tools.go (RegisterTools and each get*Tool).
3568

3669
## For developers
3770

0 commit comments

Comments
 (0)