Skip to content

Commit 44d9bc1

Browse files
committed
ReadMe updates
1 parent 8703411 commit 44d9bc1

1 file changed

Lines changed: 77 additions & 15 deletions

File tree

README.md

Lines changed: 77 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,35 @@ A Model Context Protocol (MCP) server that exposes Truvera API functionality as
1515

1616
- `TRUVERA_API_KEY` (required): Truvera API key
1717
- `TRUVERA_API_ENDPOINT` (optional): Base API URL (default: `https://api.truvera.com`)
18+
- For testnet: `https://api-testnet.truvera.io`
1819
- `MCP_MODE` (optional): `stdio` or `http` (default `stdio`)
1920
- `MCP_PORT` (optional): HTTP port (default `3000` when `MCP_MODE=http`)
2021

2122
## Quickstart
2223

23-
1) Install dependencies
24+
1) Set up environment variables
25+
26+
Copy the example environment file and configure your API key:
27+
28+
```bash
29+
cp .env.example .env
30+
# Edit .env and set your TRUVERA_API_KEY
31+
```
32+
33+
2) Install dependencies
2434

2535
```bash
2636
npm install
2737
```
2838

29-
2) Development (stdio mode)
39+
3) Development (stdio mode)
3040

3141
```bash
3242
# run with hot-reload (tsx)
3343
npm run dev
3444
```
3545

36-
3) Build & run
46+
4) Build & run
3747

3848
```bash
3949
npm run build
@@ -47,6 +57,35 @@ Notes:
4757

4858
## Running in Docker
4959

60+
### Using Docker Compose (Recommended)
61+
62+
1) Create a `.env` file with your API key:
63+
64+
```bash
65+
cp .env.example .env
66+
# Edit .env and set your TRUVERA_API_KEY
67+
```
68+
69+
2) Start the service:
70+
71+
```bash
72+
docker-compose up -d
73+
```
74+
75+
3) View logs:
76+
77+
```bash
78+
docker-compose logs -f
79+
```
80+
81+
4) Stop the service:
82+
83+
```bash
84+
docker-compose down
85+
```
86+
87+
### Using Docker directly
88+
5089
Build image:
5190

5291
```bash
@@ -56,10 +95,10 @@ docker build -t truvera-mcp-service:latest .
5695
Run container (stdio mode):
5796

5897
```bash
59-
docker run -e TRUVERA_API_KEY=your-api-key -e TRUVERA_API_ENDPOINT=https://api.truvera.com truvera-mcp-service:latest
98+
docker run -e TRUVERA_API_KEY=your-api-key truvera-mcp-service:latest
6099
```
61100

62-
Run in HTTP mode (useful for remote MCP transports like Claude Desktop + mcp-remote):
101+
Run in HTTP mode:
63102

64103
```bash
65104
docker run -e TRUVERA_API_KEY=your-api-key -e MCP_MODE=http -e MCP_PORT=3000 -p 3000:3000 truvera-mcp-service:latest
@@ -121,7 +160,22 @@ npm run build
121160
Test with Claude Desktop or using The MCP Inspector
122161

123162
### Claude Desktop
124-
Configure the MCP server in the Claude `claude_desktop_config.json` file (located on Windows in `~\AppData\Roaming\Claude\claude_desktop_config.json`).
163+
Configure the MCP server in the Claude `claude_desktop_config.json` file:
164+
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
165+
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
166+
- **Linux**: `~/.config/Claude/claude_desktop_config.json`
167+
168+
Make sure the server is running in HTTP mode first:
169+
170+
```bash
171+
# Terminal 1: Start the server
172+
MCP_MODE=http npm run dev
173+
174+
# Terminal 2: Verify it's running
175+
curl http://localhost:3000/health
176+
```
177+
178+
Then configure Claude Desktop:
125179

126180
```json
127181
{
@@ -131,7 +185,7 @@ Configure the MCP server in the Claude `claude_desktop_config.json` file (locate
131185
"args": [
132186
"-y",
133187
"mcp-remote",
134-
"http://localhost:3000/sse",
188+
"http://localhost:3000/mcp",
135189
"--insecure"
136190
]
137191
}
@@ -140,11 +194,20 @@ Configure the MCP server in the Claude `claude_desktop_config.json` file (locate
140194
```
141195

142196
### VS Code Copilot
143-
1. Configure the MCP Server in the [mcp.json](./.vscode/mcp.json) file.
144-
2. Click the `Configure tools...` icon in the Copilot chat pane.
145-
3. Click `Update tools` under the `truvera-mcp-service-vs-code` MCP server.
146-
4. Click the checkbox beside the tools you want to enable.
147-
5. Click `OK`
197+
198+
1. Make sure the server is running in HTTP mode:
199+
200+
```bash
201+
MCP_MODE=http npm run dev
202+
```
203+
204+
2. The VS Code MCP configuration is already set up in [.vscode/mcp.json](./.vscode/mcp.json)
205+
3. Click the `Configure tools...` icon in the Copilot chat pane.
206+
4. Click `Update tools` under the `truvera-mcp-service-vs-code` MCP server.
207+
5. Click the checkbox beside the tools you want to enable.
208+
6. Click `OK`
209+
210+
The configuration in `.vscode/mcp.json`:
148211

149212
```json
150213
{
@@ -154,17 +217,16 @@ Configure the MCP server in the Claude `claude_desktop_config.json` file (locate
154217
"args": [
155218
"-y",
156219
"mcp-remote",
157-
"http://localhost:3000/sse",
220+
"http://localhost:3000/mcp",
158221
"--insecure"
159222
]
160223
}
161-
162224
}
163225
}
164226
```
165227

166228
### MCP Inspector
167-
The MCP Inspector is an open source tool that provides a GUI client for interacting with the MCP server tools.
229+
The [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) is an open source tool that provides a GUI client for interacting with the MCP server tools.
168230

169231
```bash
170232
docker run --rm \

0 commit comments

Comments
 (0)