Skip to content

Commit 11545b9

Browse files
authored
docs: add MCP (#419)
1 parent 8482fae commit 11545b9

File tree

4 files changed

+26
-4
lines changed

4 files changed

+26
-4
lines changed

website/docs/docs/ai/index.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ sidebar_label: Introduction
55

66
PactFlow's Test Generation feature, is an AI-powered capability designed to help users quickly generate Pact tests. By providing access to source code, OpenAPI descriptions, or traffic capture data, it reduces the time and effort needed to create and maintain contract tests.
77

8+
<div style={{textAlign: 'center'}}>
9+
<img src="/img/mcp2.gif" width="1024" />
10+
<p style={{marginTop: '-25px', fontStyle: 'italic', fontSize: '90%'}}>PactFlow AI with Copilot using MCP integration. Watch the <a href="https://www.youtube.com/watch?v=VNe_Y6FcBqA&t=444s">full video →</a></p>
11+
</div>
12+
813
## Features
914

1015
PactFlow AI includes a suite of features to improve the efficiency and quality of your contract tests:
@@ -14,7 +19,7 @@ PactFlow AI includes a suite of features to improve the efficiency and quality o
1419
* Seamless integration with PactFlow's Role-based Access Controls feature, enabling you to enforce and manage organizational policies
1520
* Code review (beta), enabling you to evaluate the quality of existing Pact tests and suggest best-practice improvements
1621

17-
PactFlow AI is available as a CLI and supports the following programming languages:
22+
PactFlow AI is available as a CLI or MCP server, and supports the following programming languages:
1823

1924
* Java and Kotlin
2025
* TypeScript / JavaScript

website/docs/docs/ai/quick-start.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,23 @@ You must be an Administrator or a user with the [`system_preference:manage:*` pe
1717

1818
## Installation
1919

20+
### Option 1: MCP Server (Recommended)
21+
22+
The Model Context Protocol (MCP) is the recommended way to use PactFlow AI. It provides seamless integration with IDEs and modern developer environments.
23+
24+
MCP Server exposes PactFlow AI as a *local* endpoint and works with tools like VS Code, IntelliJ, Cursor, and other MCP-compatible agents.
25+
26+
Follow the official [MCP Server documentation](https://developer.smartbear.com/smartbear-mcp/docs/mcp-server) to perform the following steps:
27+
28+
* Install the MCP Server.
29+
* Configure and start the local service.
30+
* Connect with MCP clients.
31+
32+
This option is ideal for teams working with AI copilots or looking to automate testing workflows.
33+
34+
### Option 2: CLI
35+
36+
You can also use PactFlow AI using the CLI. It supports test generation and review from the terminal.
2037
For *nix users (including Windows users running WSL/msys2/mingw), use the following command to download and install:
2138

2239
```sh
@@ -29,7 +46,7 @@ For Windows PowerShell users, use the following command to download and install:
2946
Invoke-WebRequest -Uri https://download.pactflow.io/ai/get.ps1 | Invoke-Expression
3047
```
3148

32-
### Installation Options
49+
#### Installation Options
3350

3451
There are some options which you can set during installation.
3552

@@ -48,7 +65,7 @@ curl https://download.pactflow.io/ai/get.sh | sh -s -- -h
4865

4966
Verify the installation by running `pactflow-ai` to ensure it executes successfully.
5067

51-
### Manual installation
68+
#### Manual installation
5269

5370
Alternatively, download the latest version for your OS and architecture from the table below. Be sure to add it to your environment's `PATH`:
5471

@@ -60,7 +77,7 @@ Linux GNU users will require glibc version 2.23 or later.
6077
Environments which do not use glibc, or use a version of glibc prior to 2.23, should instead use the musl variant.
6178
:::
6279

63-
## Getting Started
80+
### Getting Started
6481

6582
:::note
6683
Running `pactflow-ai --help` will show detailed usage for any subcommands.

website/static/img/mcp.gif

1.53 MB
Loading

website/static/img/mcp2.gif

2.01 MB
Loading

0 commit comments

Comments
 (0)