Skip to content

Commit ad2bd46

Browse files
Huagang XieHuagang Xie
authored andcommitted
update readme
1 parent 2ae3ba7 commit ad2bd46

File tree

1 file changed

+60
-2
lines changed

1 file changed

+60
-2
lines changed

README.md

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,21 +46,39 @@ A [Model Context Protocol](https://modelcontextprotocol.com/) server that provid
4646

4747
### Vanta OAuth Credentials
4848

49+
You can provide your Vanta OAuth credentials in **one of two ways**:
50+
51+
#### Option 1: Using a JSON Env File (Recommended)
52+
4953
1. Create OAuth credentials from [Vanta's developer dashboard](https://developer.vanta.com/docs/api-access-setup)
50-
2. Save the `client_id` and `client_secret` to an env file:
54+
2. Save the `client_id` and `client_secret` to a JSON file:
5155
```json
5256
{
5357
"client_id": "your_client_id_here",
5458
"client_secret": "your_client_secret_here"
5559
}
5660
```
61+
3. Set the `VANTA_ENV_FILE` environment variable to the absolute path of this file.
62+
63+
#### Option 2: Using Environment Variables Directly
64+
65+
Set the following environment variables in your shell, `.env` file, or MCP config:
66+
67+
```bash
68+
export VANTA_CLIENT_ID="your_client_id_here"
69+
export VANTA_CLIENT_SECRET="your_client_secret_here"
70+
```
71+
72+
> **Note:** If both `VANTA_ENV_FILE` and the direct environment variables are set, the direct environment variables take precedence.
5773
5874
> **Note:** Vanta currently allows only a single active access_token per Application. [More info here](https://developer.vanta.com/docs/api-access-setup#authentication-and-token-retrieval)
5975
6076
### Usage with Claude Desktop
6177

6278
Add the server to your `claude_desktop_config.json`:
6379

80+
**Option 1: Using VANTA_ENV_FILE**
81+
6482
```json
6583
{
6684
"mcpServers": {
@@ -75,12 +93,31 @@ Add the server to your `claude_desktop_config.json`:
7593
}
7694
```
7795

96+
**Option 2: Using Direct Environment Variables**
97+
98+
```json
99+
{
100+
"mcpServers": {
101+
"vanta": {
102+
"command": "npx",
103+
"args": ["-y", "@vantasdk/vanta-mcp-server"],
104+
"env": {
105+
"VANTA_CLIENT_ID": "your_client_id_here",
106+
"VANTA_CLIENT_SECRET": "your_client_secret_here"
107+
}
108+
}
109+
}
110+
}
111+
```
112+
78113
If you are unfamiliar with setting up MCP servers in Claude Desktop, [here is an example](https://modelcontextprotocol.io/quickstart/user) in the official MCP documentation.
79114

80115
### Usage with Cursor
81116

82117
Add the server to your Cursor MCP settings:
83118

119+
**Option 1: Using VANTA_ENV_FILE**
120+
84121
```json
85122
{
86123
"mcpServers": {
@@ -95,11 +132,32 @@ Add the server to your Cursor MCP settings:
95132
}
96133
```
97134

135+
**Option 2: Using Direct Environment Variables**
136+
137+
```json
138+
{
139+
"mcpServers": {
140+
"Vanta": {
141+
"command": "npx",
142+
"args": ["-y", "@vantasdk/vanta-mcp-server"],
143+
"env": {
144+
"VANTA_CLIENT_ID": "your_client_id_here",
145+
"VANTA_CLIENT_SECRET": "your_client_secret_here"
146+
}
147+
}
148+
}
149+
}
150+
```
151+
98152
### Environment Variables
99153

100-
- `VANTA_ENV_FILE` (required): Absolute path to the JSON file containing your OAuth credentials
154+
- `VANTA_ENV_FILE` (optional): Absolute path to the JSON file containing your OAuth credentials
155+
- `VANTA_CLIENT_ID` (optional): Your Vanta OAuth client ID (takes precedence if set)
156+
- `VANTA_CLIENT_SECRET` (optional): Your Vanta OAuth client secret (takes precedence if set)
101157
- `REGION` (optional): API region - `us`, `eu`, or `aus` (defaults to `us`)
102158

159+
> You must provide either `VANTA_ENV_FILE` **or** both `VANTA_CLIENT_ID` and `VANTA_CLIENT_SECRET`.
160+
103161
## Installation
104162

105163
### NPX (Recommended)

0 commit comments

Comments
 (0)