Skip to content

docs: improve getting started experience #217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
May 7, 2025
Merged

docs: improve getting started experience #217

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b5cf6e7
docs: improve getting started experience
wtrocki May 7, 2025
2779c1b
Update README.md
wtrocki May 7, 2025
795625c
Update README.md
wtrocki May 7, 2025
519b108
Update README.md
wtrocki May 7, 2025
4652a39
Update README.md
wtrocki May 7, 2025
4a6a5d4
Update README.md
wtrocki May 7, 2025
5288d11
Update README.md
wtrocki May 7, 2025
99814f1
fix: format
wtrocki May 7, 2025
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
19 changes: 17 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,24 @@ Use your Atlas API Service Accounts credentials. Must follow all the steps in [A
}
```

#### Other options
### Option 3: Standalone Service using command arguments

Alternatively you can use environment variables in the config file or set them and run the server via npx.
Start Server using npx command:

```shell
npx -y mongodb-mcp-server --apiClientId="your-atlas-service-accounts-client-id" --apiClientSecret="your-atlas-service-accounts-client-secret"
```

- For a complete list of arguments see [Configuration Options](#configuration-options)
- To configure your Atlas Service Accounts credentials please refer to [Atlas API Access](#atlas-api-access)

#### Option 4: Standalone Service using environment variables

```shell
npx -y mongodb-mcp-server
```

You can use environment variables in the config file or set them and run the server via npx.

- Connection String via environment variables in the MCP file [example](#connection-string-with-environment-variables)
- Atlas API credentials via environment variables in the MCP file [example](#atlas-api-credentials-with-environment-variables)
Expand Down
Loading