Skip to content
Open
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
57 changes: 57 additions & 0 deletions examples/mcp/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# MCP Client Config Examples

Copy one of these examples into your MCP client config and replace the
`NAVVI_GPG_PASSPHRASE` placeholder with your own stable passphrase.

## Cursor

For project-specific tools, create `.cursor/mcp.json` in your project and use:

```json
{
"mcpServers": {
"navvi": {
"command": "uvx",
"args": ["navvi@latest"],
"env": {
"NAVVI_GPG_PASSPHRASE": "pick-any-random-string-here"
}
}
}
}
```

The same JSON is available in `cursor.mcp.json`.

## Windsurf

Open Windsurf's raw MCP config at `~/.codeium/windsurf/mcp_config.json` and use:

```json
{
"mcpServers": {
"navvi": {
"command": "uvx",
"args": ["navvi@latest"],
"env": {
"NAVVI_GPG_PASSPHRASE": "pick-any-random-string-here"
}
}
}
}
```

The same JSON is available in `windsurf.mcp_config.json`.

## Notes

- `NAVVI_GPG_PASSPHRASE` enables Navvi's credential vault. Keep it stable for
the Docker volume that stores credentials.
- Restart or refresh MCP servers in your client after changing the config.
- These examples use `uvx navvi@latest`, matching the top-level README quick
start.

References:

- Cursor MCP project configuration: https://docs.cursor.com/advanced/model-context-protocol
- Windsurf Cascade MCP configuration: https://docs.windsurf.com/windsurf/cascade/mcp
11 changes: 11 additions & 0 deletions examples/mcp/cursor.mcp.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"mcpServers": {
"navvi": {
"command": "uvx",
"args": ["navvi@latest"],
"env": {
"NAVVI_GPG_PASSPHRASE": "pick-any-random-string-here"
}
}
}
}
11 changes: 11 additions & 0 deletions examples/mcp/windsurf.mcp_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"mcpServers": {
"navvi": {
"command": "uvx",
"args": ["navvi@latest"],
"env": {
"NAVVI_GPG_PASSPHRASE": "pick-any-random-string-here"
}
}
}
}