Skip to content

Commit 9308870

Browse files
committed
Update readme
1 parent b0d4a4d commit 9308870

File tree

1 file changed

+164
-29
lines changed

1 file changed

+164
-29
lines changed

README.md

Lines changed: 164 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,16 @@ For example, instead of logging into the ReportPortal UI, you could ask your AI
1919

2020
## Installation
2121

22-
There are two ways to run the latest version of the ReportPortal MCP Server.
23-
Each of this way is suitable for any LLM provider.
22+
There are three ways to connect to the ReportPortal MCP Server:
23+
1. **Via Docker** (recommended for local installation)
24+
2. **Using pre-built binaries** (for local installation)
25+
3. **Connecting to a remote MCP server** (when the server is already deployed)
2426

25-
### Via Docker (recommended).
27+
Each of these methods is suitable for any LLM provider.
28+
29+
### Local installation
30+
31+
#### Via Docker (recommended)
2632

2733
The MCP server is available on the official ReportPortal's [DockerHub](https://hub.docker.com/r/reportportal/mcp-server).
2834

@@ -52,7 +58,7 @@ Configuration:
5258
}
5359
```
5460

55-
### Using pre-built binaries.
61+
#### Using pre-built binaries
5662

5763
The OS pre-built binaries can be downloaded from the official releases on [GitHub](https://github.com/reportportal/reportportal-mcp-server/releases).
5864

@@ -71,39 +77,31 @@ Configuration:
7177
}
7278
```
7379

74-
Choose your favourite AI Tool to connect.
80+
### Connecting to a Remote MCP Server
7581

76-
### Claude Desktop
82+
If the ReportPortal MCP Server is already **deployed** and accessible via HTTP, you can connect to it remotely without running it locally. This is useful when the server is hosted centrally or in a shared environment.
7783

78-
1. Open Claude Desktop, go to **Settings → Developer → Edit Config**.
79-
2. Add a new MCP server entry that runs the ReportPortal MCP Server.
84+
**Remote Server Configuration:**
8085
```json
8186
{
82-
"mcpServers": {
83-
"reportportal": {
84-
// choose the Docker or binary configuration from the section above
87+
"reportportal": {
88+
"url": "http://your-mcp-server-host:port/mcp/",
89+
"headers": {
90+
"Authorization": "Bearer your-api-token",
91+
"X-Project": "YourProjectInReportPortal"
8592
}
8693
}
8794
}
8895
```
89-
3. Save and restart Claude Desktop.
9096

91-
### Claude Code CLI
92-
93-
1. Open your terminal.
94-
2. Run the following comman.
95-
```bash
96-
claude mcp add-json reportportal '{"command": "docker", "args": ["run", "-i", "--rm", "-e", "RP_API_TOKEN", "-e", "RP_HOST", "-e", "RP_PROJECT", "reportportal/mcp-server"], "env": {"RP_API_TOKEN": "your-api-token", "RP_HOST": "https://your-reportportal-instance.com", "RP_PROJECT": "YourProjectInReportPortal"}}'
97-
```
97+
**Configuration Parameters:**
98+
- `url`: The HTTP endpoint URL of the remote MCP server (must end with `/mcp/`)
99+
- `headers.Authorization`: Bearer token for authentication (required)
100+
- `headers.X-Project`: The ReportPortal project name (optional)
98101

99-
**Configuration Options:**
100-
- Use `-s user` to add the server to your user configuration (available across all projects).
101-
- Use `-s project` to add the server to project-specific configuration (shared via `.mcp.json`).
102-
- Default scope is `local` (available only to you in the current project).
103-
104-
Documentation: [Claude Code guide](https://docs.anthropic.com/en/docs/claude-code/mcp).
102+
Choose your favourite AI Tool to connect.
105103

106-
### Cursor (AI Code Editor)
104+
#### Cursor (AI Code Editor)
107105

108106
Just click
109107

@@ -113,6 +111,8 @@ Or follow the next steps:
113111

114112
1. In Cursor, go to **Settings → Extensions → MCP** and click to add a new global MCP server.
115113
2. Add a new MCP server entry that runs the ReportPortal MCP Server.
114+
115+
**For local installation (Docker or binary):**
116116
```json
117117
{
118118
"mcpServers": {
@@ -122,15 +122,33 @@ Or follow the next steps:
122122
}
123123
}
124124
```
125+
126+
**For remote server:**
127+
```json
128+
{
129+
"mcpServers": {
130+
"reportportal": {
131+
"url": "http://your-mcp-server-host:port/mcp/",
132+
"headers": {
133+
"Authorization": "Bearer your-api-token",
134+
"X-Project": "YourProjectInReportPortal"
135+
}
136+
}
137+
}
138+
}
139+
```
140+
125141
Documentation: [Cursor MCP](https://docs.cursor.com/en/tools/developers#example).
126142

127-
### GitHub Copilot (In VS Code and JetBrains IDEs)
143+
#### GitHub Copilot (In VS Code and JetBrains IDEs)
128144

129-
#### VS Code
145+
##### VS Code
130146

131147
1. Install/update the GitHub Copilot plugin.
132148
2. Type **>mcp** in the search bar and select **MCP: Open User Configuration**.
133149
3. Add configuration:
150+
151+
**For local installation (Docker or binary):**
134152
```json
135153
{
136154
"servers": {
@@ -141,13 +159,32 @@ Documentation: [Cursor MCP](https://docs.cursor.com/en/tools/developers#example)
141159
}
142160
```
143161

162+
**For remote server:**
163+
```json
164+
{
165+
"servers": {
166+
"reportportal": {
167+
"url": "http://your-mcp-server-host:port/mcp/",
168+
"requestInit": {
169+
"headers": {
170+
"Authorization": "Bearer your-api-token",
171+
"X-Project": "YourProjectInReportPortal"
172+
}
173+
}
174+
}
175+
}
176+
}
177+
```
178+
144179
Documentation: [VS Code Copilot Guide](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
145180

146-
#### JetBrains IDEs
181+
##### JetBrains IDEs
147182

148183
1. Install/update the GitHub Copilot plugin.
149184
2. Click **GitHub Copilot icon in the status bar → Edit Settings → Model Context Protocol → Configure**.
150185
3. Add configuration:
186+
187+
**For local installation (Docker or binary):**
151188
```json
152189
{
153190
"servers": {
@@ -157,10 +194,106 @@ Documentation: [VS Code Copilot Guide](https://code.visualstudio.com/docs/copilo
157194
}
158195
}
159196
```
197+
198+
**For remote server:**
199+
```json
200+
{
201+
"servers": {
202+
"reportportal": {
203+
"url": "http://your-mcp-server-host:port/mcp/",
204+
"requestInit": {
205+
"headers": {
206+
"Authorization": "Bearer your-api-token",
207+
"X-Project": "YourProjectInReportPortal"
208+
}
209+
}
210+
}
211+
}
212+
}
213+
```
214+
160215
4. Press `Ctrl + S` or `Command + S` to save, or close the `mcp.json` file. The configuration should take effect immediately and restart all the MCP servers defined. You can restart the IDE if needed.
161216

162217
Documentation: [JetBrains Copilot Guide](https://plugins.jetbrains.com/plugin/17718-github-copilot).
163218

219+
#### Claude Desktop
220+
221+
1. Open Claude Desktop, go to **Settings → Developer → Edit Config**.
222+
2. Add a new MCP server entry that runs the ReportPortal MCP Server.
223+
224+
**For local installation (Docker or binary):**
225+
```json
226+
{
227+
"mcpServers": {
228+
"reportportal": {
229+
// choose the Docker or binary configuration from the section above
230+
}
231+
}
232+
}
233+
```
234+
235+
**For remote server:**
236+
237+
TBU
238+
239+
3. Save and restart Claude Desktop.
240+
241+
#### Claude Code CLI
242+
243+
1. Open your terminal.
244+
2. Run one of the following commands.
245+
246+
**For local installation (Docker):**
247+
```bash
248+
claude mcp add-json reportportal '{"command": "docker", "args": ["run", "-i", "--rm", "-e", "RP_API_TOKEN", "-e", "RP_HOST", "-e", "RP_PROJECT", "reportportal/mcp-server"], "env": {"RP_API_TOKEN": "your-api-token", "RP_HOST": "https://your-reportportal-instance.com", "RP_PROJECT": "YourProjectInReportPortal"}}'
249+
```
250+
251+
**For remote server:**
252+
```bash
253+
claude mcp add-json reportportal '{"url": "http://your-mcp-server-host:port/mcp/", "headers": {"Authorization": "Bearer your-api-token", "X-Project": "YourProjectInReportPortal"}}'
254+
```
255+
256+
**Configuration Options:**
257+
- Use `-s user` to add the server to your user configuration (available across all projects).
258+
- Use `-s project` to add the server to project-specific configuration (shared via `.mcp.json`).
259+
- Default scope is `local` (available only to you in the current project).
260+
261+
Documentation: [Claude Code guide](https://docs.anthropic.com/en/docs/claude-code/mcp).
262+
263+
#### Other Coding Agents
264+
265+
The ReportPortal MCP Server is compatible with any MCP-compatible coding agent. While the exact configuration format may vary, most agents support either:
266+
267+
**Local installation (stdio mode):**
268+
```json
269+
{
270+
"reportportal": {
271+
"command": "docker",
272+
"args": ["run", "-i", "--rm", "-e", "RP_API_TOKEN", "-e", "RP_HOST", "-e", "RP_PROJECT", "reportportal/mcp-server"],
273+
"env": {
274+
"RP_API_TOKEN": "your-api-token",
275+
"RP_HOST": "https://your-reportportal-instance.com",
276+
"RP_PROJECT": "YourProjectInReportPortal"
277+
}
278+
}
279+
}
280+
```
281+
282+
**Remote server (HTTP mode):**
283+
```json
284+
{
285+
"reportportal": {
286+
"url": "http://your-mcp-server-host:port/mcp/",
287+
"headers": {
288+
"Authorization": "Bearer your-api-token",
289+
"X-Project": "YourProjectInReportPortal"
290+
}
291+
}
292+
}
293+
```
294+
295+
Please refer to your coding agent's documentation for the exact configuration format and where to place the configuration file.
296+
164297
Once connected, your AI assistant will list ReportPortal-related "tools" it can invoke. You can then ask your questions in chat, and the assistant will call those tools on your behalf.
165298

166299
## ReportPortal compatibility
@@ -206,6 +339,8 @@ The ReportPortal MCP server provides a comprehensive set of capabilities for int
206339
| Get Logs by filter | Lists logs for a specific test item or nested step | `parent-id` (required), `log_level`, `log_content`, `logs_with_attachments`, `status`, `sort`, `page`, `page-size` (all optional) |
207340
| Get Attachment by ID | Retrieves an attachment binary by id | `attachment_id` |
208341
| Get Test Item by ID | Retrieves details of a specific test item | `test_item_id` |
342+
| Get Project Defect Types | Retrieves details regarding existing defect types on the specific project | |
343+
| Update defect types by item ids | Retrieves details regarding existing defect types on the specific project |`test_items_ids` (required), `defect_type_id` (required), `defect_type_comment` (optional) |
209344

210345
### Available Prompts
211346

0 commit comments

Comments
 (0)