Skip to content

Commit 5050b97

Browse files
committed
docs: enhance README with detailed installation notes and pre-installation tips
1 parent dc24d8e commit 5050b97

1 file changed

Lines changed: 46 additions & 8 deletions

File tree

README.md

Lines changed: 46 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,22 @@ A Model Context Protocol (MCP) server for [Factifai](https://github.com/presidio
1919

2020
## Table of Contents
2121

22-
- [Requirements](#requirements)
23-
- [Installation](#installation)
24-
- [Configuration](#configuration)
25-
- [IDE Integration](#factifai-mcp-integration-with-popular-ide-and-extension)
26-
- [Available Tools](#available-tools)
27-
- [Contributing](#contributing)
28-
- [Security](#security)
29-
- [License](#license)
22+
- [Factifai MCP Server](#factifai-mcp-server)
23+
- [Table of Contents](#table-of-contents)
24+
- [Requirements](#requirements)
25+
- [Installation](#installation)
26+
- [Installation Note](#installation-note)
27+
- [Pre-Installation Tip](#pre-installation-tip)
28+
- [Configuration](#configuration)
29+
- [Environment Variables](#environment-variables)
30+
- [Model Provider Configuration Examples](#model-provider-configuration-examples)
31+
- [Bedrock Configuration Example](#bedrock-configuration-example)
32+
- [OpenAI Configuration Example](#openai-configuration-example)
33+
- [Factifai MCP integration with popular IDE and extension](#factifai-mcp-integration-with-popular-ide-and-extension)
34+
- [Available Tools](#available-tools)
35+
- [Contributing](#contributing)
36+
- [Security](#security)
37+
- [License](#license)
3038

3139
## Requirements
3240

@@ -45,6 +53,36 @@ npx --yes @presidio-dev/factifai-mcp-server@1.2.3
4553

4654
We recommend `npx` to install the server, but you can use any node package manager of your preference such as `yarn`, `pnpm`, `bun`, etc.
4755

56+
### Installation Note
57+
58+
⚠️ **Important**: The first time you install Factifai MCP Server, it will automatically download and install browser dependencies using Playwright. This process may take several minutes depending on your internet connection and system specifications.
59+
60+
The installation includes:
61+
- Downloading browser binaries (Chromium, Firefox, WebKit)
62+
- Installing browser dependencies
63+
- Setting up the necessary environment
64+
65+
This happens only once, and subsequent runs will be much faster as the browsers are already installed.
66+
67+
### Pre-Installation Tip
68+
69+
⚠️ **Recommended for First-Time Installation**: Many MCP clients have strict timeout limits for server startup. The browser installation process during first-time setup may exceed these timeouts, causing the installation to fail or appear non-responsive.
70+
71+
To avoid timeout issues, we strongly recommend pre-installing Playwright browsers manually:
72+
73+
```bash
74+
# Step 1: Install Playwright browsers manually before installing the MCP server
75+
npx playwright install --with-deps
76+
77+
# Step 2: Then install the MCP server (will be much faster and avoid timeouts)
78+
npx --yes @presidio-dev/factifai-mcp-server@latest
79+
```
80+
81+
This pre-installation step:
82+
1. Ensures browsers are downloaded without MCP client timeout constraints
83+
2. Significantly speeds up the MCP server's first-time installation
84+
3. Prevents installation failures due to timeout issues in your IDE or MCP client
85+
4886
## Configuration
4987

5088
with [`npx`](https://docs.npmjs.com/cli/v8/commands/npx) with latest version:

0 commit comments

Comments
 (0)