From b5cf6e77f5009cccf819be36d7a85cd1de4ae2e1 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Wed, 7 May 2025 14:25:44 +0200 Subject: [PATCH 1/8] docs: improve getting started experience --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 91b87f5..ae8c612 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,14 @@ node -v ### Quick Start +Start Server using npx command: + +``` + npx -y mongodb-mcp-server --apiClientId="your-atlas-service-accounts-client-id" --apiClientSecret="your-atlas-service-accounts-client-secret" --logPath=dev-logs +``` + +#### Configuration Options + Most MCP clients require a configuration file to be created or modified to add the MCP server. Note: The configuration file syntax can be different across clients. Please refer to the following links for the latest expected syntax: From 2779c1ba9dfb2a1a359066927f1dafd5fa0b8c08 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Wed, 7 May 2025 14:27:14 +0200 Subject: [PATCH 2/8] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ae8c612..8118560 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ node -v 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" --logPath=dev-logs ``` From 795625c0021c2e9d046156e2ff1043b9d3d16429 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Wed, 7 May 2025 14:32:39 +0200 Subject: [PATCH 3/8] Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8118560..94d3217 100644 --- a/README.md +++ b/README.md @@ -36,14 +36,6 @@ node -v ### Quick Start -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" --logPath=dev-logs -``` - -#### Configuration Options - Most MCP clients require a configuration file to be created or modified to add the MCP server. Note: The configuration file syntax can be different across clients. Please refer to the following links for the latest expected syntax: @@ -95,6 +87,14 @@ Use your Atlas API Service Accounts credentials. Must follow all the steps in [A } ``` +### Option 3: Standalone Service using command arguments + +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" --logPath=dev-logs +``` + #### Other options Alternatively you can use environment variables in the config file or set them and run the server via npx. From 519b10877ceebd35630c5ca2bb0d59114521ed25 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Wed, 7 May 2025 14:34:05 +0200 Subject: [PATCH 4/8] Update README.md Co-authored-by: Bianca Lisle <40155621+blva@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 94d3217..4bb9f7d 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ Use your Atlas API Service Accounts credentials. Must follow all the steps in [A 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" --logPath=dev-logs + npx -y mongodb-mcp-server --apiClientId="your-atlas-service-accounts-client-id" --apiClientSecret="your-atlas-service-accounts-client-secret" ``` #### Other options From 4652a395c569c00247207393dee31b364fe01134 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Wed, 7 May 2025 14:41:33 +0200 Subject: [PATCH 5/8] Update README.md --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4bb9f7d..3ce92f2 100644 --- a/README.md +++ b/README.md @@ -95,9 +95,16 @@ Start Server using npx command: npx -y mongodb-mcp-server --apiClientId="your-atlas-service-accounts-client-id" --apiClientSecret="your-atlas-service-accounts-client-secret" ``` -#### Other options +For complete list of arguments see [Configuration Options](#configuration-options) +For Atlas API credentials please refer to [Atlas API Access](#atlas-api-access) -Alternatively you can use environment variables in the config file or set them and run the server via npx. +#### Option 4: Use environment variables with CLI + +```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) From 4a6a5d4de0f60d9335b411db6edb1afabb080ffb Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Wed, 7 May 2025 14:46:31 +0200 Subject: [PATCH 6/8] Update README.md Co-authored-by: Bianca Lisle <40155621+blva@users.noreply.github.com> --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3ce92f2..a5e710c 100644 --- a/README.md +++ b/README.md @@ -95,8 +95,8 @@ Start Server using npx command: npx -y mongodb-mcp-server --apiClientId="your-atlas-service-accounts-client-id" --apiClientSecret="your-atlas-service-accounts-client-secret" ``` -For complete list of arguments see [Configuration Options](#configuration-options) -For Atlas API credentials please refer to [Atlas API Access](#atlas-api-access) +- 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: Use environment variables with CLI From 5288d115d3f2c4756ecb5dc5e8d4cc5c04d77861 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Wed, 7 May 2025 14:52:13 +0200 Subject: [PATCH 7/8] Update README.md Co-authored-by: Bianca Lisle <40155621+blva@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a5e710c..895cf6a 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ Start Server using npx command: - 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: Use environment variables with CLI +#### Option 4: Standalone Service using environment variables ```shell npx -y mongodb-mcp-server From 99814f17bb65133a5494401ea83de8c9c4b1dff7 Mon Sep 17 00:00:00 2001 From: Wojciech Trocki Date: Wed, 7 May 2025 16:48:15 +0200 Subject: [PATCH 8/8] fix: format --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 895cf6a..28c0c75 100644 --- a/README.md +++ b/README.md @@ -98,10 +98,10 @@ Start Server using npx command: - 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 +#### Option 4: Standalone Service using environment variables ```shell - npx -y mongodb-mcp-server + npx -y mongodb-mcp-server ``` You can use environment variables in the config file or set them and run the server via npx.