Skip to content
Merged

Release #1032

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
136 changes: 90 additions & 46 deletions docs/external-integrations/MCPServer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,99 @@ ReportPortal MCP Server allows to receive summaries of launches and perform vari

Available tools:

1. Run Unique Error Analysis.
2. Run Quality Gate.
3. Run Auto-Analysis.
4. Get Test Items by Filter.
5. Get Launches.
6. Launch Force Finish.
7. Launch Delete.
8. Get Test Item Logs by Filter.
9. Get Test Item by ID.
10. Get Test Item Attachments.
11. Get Last Launch by Name.
1. Run Unique Error Analysis
2. Run Quality Gate
3. Run Auto-Analysis
4. Get Test Items by Filter
5. Get Launches
6. Launch Force Finish
7. Launch Delete
8. Get Test Item Logs by Filter
9. Get Test Item by ID
10. Get Test Item Attachments
11. Get Last Launch by Name
12. Get Project Defect Types
13. Update defect types by item IDs

## Usage with your favorite AI tools

Below are brief setup instructions for configuring the ReportPortal MCP Server with Cursor, Copilot, and Claude Desktop.

### Cursor IDE

#### Local installation

To configure ReportPortal MCP Server with Cursor:

1. Log in to Cursor.
2. Open Settings.
3. Select "Tools & Integrations" section.
4. Click "New MCP Server".

<MediaViewer src={require('./img/mcp-server/Cursor1.JPG')} alt="Cursor Settings" />

5. Fill in the required fields in the Config file.

<MediaViewer src={require('./img/mcp-server/Cursor2.JPG')} alt="Cursor Config file" />

6. The list of available tools appears.

<MediaViewer src={require('./img/mcp-server/Cursor3.JPG')} alt="ReportPortal MCP Server configured with Cursor" />

#### Remote server

This setup allows Cursor to communicate with a remote ReportPortal MCP Server.

```json
{
"mcpServers": {
"reportportal": {
"url": "http://your-mcp-server-host:port/mcp/",
"headers": {
"Authorization": "Bearer your-api-token",
"X-Project": "YourProjectInReportPortal"
}
}
}
}
```

### GitHub Copilot

#### Local installation

To configure ReportPortal MCP Server with Copilot:

1. Log in to Copilot.
2. Type ">mcp" in the search bar.
3. Select "MCP: Open User Configuration" option.

<MediaViewer src={require('./img/mcp-server/Copilot1.jpg')} alt="Copilot settings" />

4. Fill in the required fields in the Config file.

<MediaViewer src={require('./img/mcp-server/Copilot2.JPG')} alt="Copilot Config file" />

#### Remote server

Use this configuration to connect Copilot to a remote ReportPortal MCP Server.

```json
{
"servers": {
"reportportal": {
"url": "http://your-mcp-server-host:port/mcp/",
"requestInit": {
"headers": {
"Authorization": "Bearer your-api-token",
"X-Project": "YourProjectInReportPortal"
}
}
}
}
}
```

### Claude Desktop

To configure ReportPortal MCP Server with Claude:
Expand Down Expand Up @@ -78,41 +157,6 @@ Token is API Key the user's Profile page.
<MediaViewer src={require('./img/mcp-server/MCP9-2.png')} alt="Summary from AI based on the data from our qa metrics dashboard" />
<MediaViewer src={require('./img/mcp-server/MCP10.png')} alt="Launches page" />

Below are brief setup instructions for configuring the ReportPortal MCP Server with Cursor and Copilot.

### Cursor IDE

To configure ReportPortal MCP Server with Cursor:

1. Log in to Cursor.
2. Open Settings.
3. Select "Tools & Integrations" section.
4. Click "New MCP Server".

<MediaViewer src={require('./img/mcp-server/Cursor1.JPG')} alt="Cursor Settings" />

5. Fill in the required fields in the Config file.

<MediaViewer src={require('./img/mcp-server/Cursor2.JPG')} alt="Cursor Config file" />

6. The list of available tools appears.

<MediaViewer src={require('./img/mcp-server/Cursor3.JPG')} alt="ReportPortal MCP Server configured with Cursor" />

### GitHub Copilot

To configure ReportPortal MCP Server with Copilot:

1. Log in to Copilot.
2. Type ">mcp" in the search bar.
3. Select "MCP: Open User Configuration" option.

<MediaViewer src={require('./img/mcp-server/Copilot1.jpg')} alt="Copilot settings" />

4. Fill in the required fields in the Config file.

<MediaViewer src={require('./img/mcp-server/Copilot2.JPG')} alt="Copilot Config file" />

Refer to the detailed user guide for the [full setup instructions](https://github.com/reportportal/reportportal-mcp-server) of the MCP Server.

Whether you're aiming to optimize test analysis or simplify routine QA tasks, MCP empowers your AI tools to act with clarity and precision.
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,20 @@ Create the configuration file `pytest.ini` in the root directory of tests, or al

The `pytest.ini` file should have next mandatory fields:

- `rp_api_key` - value could be found in the User Profile section
- `rp_project` - name of project in ReportPortal
- `rp_endpoint` - address of ReportPortal Server

And one type of authorization: API Key or OAuth 2.0 Password grant. You can do this by setting:
- `rp_api_key` or `RP_API_KEY` environment variable. You can get it in the User Profile section on the UI.

Or:
- `rp_oauth_uri` - OAuth 2.0 token endpoint URL for password grant authentication. **Required** if API key is not used.
- `rp_oauth_username` - OAuth 2.0 username for password grant authentication. **Required** if OAuth 2.0 is used.
- `rp_oauth_password` - OAuth 2.0 password for password grant authentication. **Required** if OAuth 2.0 is used.
- `rp_oauth_client_id` - OAuth 2.0 client identifier. **Required** if OAuth 2.0 is used.
- `rp_oauth_client_secret` - OAuth 2.0 client secret. **Optional** for OAuth 2.0 authentication.
- `rp_oauth_scope` - OAuth 2.0 access token scope. **Optional** for OAuth 2.0 authentication.

Example of `pytest.ini`:

```python
Expand All @@ -47,8 +57,6 @@ Example of `pytest.ini`:
rp_ignore_attributes = 'xfail' 'usefixture'
```

- The `rp_api_key` can also be set with the environment variable `RP_API_KEY`. This will override the value set for `rp_api_key` in pytest.ini

The following parameters are optional:

- `rp_client_type = SYNC` - Type of the under-the-hood ReportPortal client implementation. Possible values: [SYNC, ASYNC_THREAD, ASYNC_BATCHED].
Expand All @@ -65,7 +73,7 @@ The following parameters are optional:
- `rp_connect_timeout = 15` - Connection timeout to ReportPortal server. Default value is "10.0".
- `rp_read_timeout = 15` - Response read timeout for ReportPortal connection. Default value is "10.0".
- `rp_log_batch_size = 20` - size of batch log request.
- `rp_log_batch_payload_size = 65000000` - maximum payload size in bytes of async batch log requests.
- `rp_log_batch_payload_limit = 65000000` - maximum payload size in bytes of async batch log requests.
- `rp_log_level = INFO` - The log level that will be reported.
- `rp_log_format = [%(levelname)7s] (%(name)s) %(message)s (%(filename)s:%(lineno)s)` - Format string to be used for logs sent to the service.
- `rp_ignore_attributes = 'xfail' 'usefixture'` - Ignore specified pytest markers.
Expand Down
Loading