Skip to content
Merged
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
33 changes: 32 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This project implements a Model Context Protocol (MCP) server for MongoDB and Mo
npm install
```

3. Add the mcp server to your IDE of choice
3. Add the mcp server to your IDE of choice (see the [README](README.md) for detailed client integration instructions)
```json
{
"mcpServers": {
Expand Down Expand Up @@ -57,6 +57,37 @@ This project implements a Model Context Protocol (MCP) server for MongoDB and Mo

4. Commit your changes with a descriptive commit message

## Troubleshooting

### Restart Server

- Run `npm run build` to re-build the server if you made changes to the code
- Press `Cmd + Shift + P` and type List MCP Servers
- Select the MCP server you want to restart
- Select the option to restart the server

### View Logs

To see MCP logs, check https://code.visualstudio.com/docs/copilot/chat/mcp-servers.

- Press `Cmd + Shift + P` and type List MCP Servers
- Select the MCP server you want to see logs for
- Select the option to view logs in the output panel

### Debugging

For debugging, we use the MCP inspector tool. From the root of this repository, run:

```shell
npm run inspect
```

This is equivalent to:

```shell
npx @modelcontextprotocol/inspector -- node dist/index.js
```

## Pull Request Guidelines

1. Update documentation if necessary
Expand Down
10 changes: 0 additions & 10 deletions FEATURES.md

This file was deleted.

55 changes: 13 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
# Atlas MCP Server PoC
# Atlas MCP Server

A Model Context Protocol server for interacting with MongoDB Atlas.

Developed using the official MCP SDK https://github.com/modelcontextprotocol/typescript-sdk
A Model Context Protocol server for interacting with MongoDB Atlas. This project implements a Model Context Protocol (MCP) server enabling AI assistants to interact with MongoDB Atlas resources through natural language.

## 📚 Table of Contents

- [🚀 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the MCP Server](#running-the-mcp-server)
- [🔧 Troubleshooting](#troubleshooting)
- [Restart Server](#restart-server)
- [View Logs](#view-logs)
- [Debugging](#debugging)
- [🛠️ Supported Tools](#supported-tools)
- [Tool List](#tool-list)
- [👩‍💻 Client Integration](#client-integration)
- [VSCode](#vscode)
- [Claude](#claude)
- [🤝 Contributing](#contributing)

## 🚀 Getting Started

### Prerequisites

- Node.js installed
- Node.js (v23 or later)
- MongoDB Atlas account

### Installation

```shell
# Clone the repository
git clone https://github.com/mongodb-labs/mongodb-mcp-server.git
cd mongodb-mcp-server

# Install dependencies
npm install
```

Expand All @@ -39,39 +39,6 @@ npm install
npm run build
```

## 🔧 Troubleshooting

### Restart Server

- Run `npm run build` to re-build the server if you made changes to the code
- Press `Cmd + Shift + P` and type List MCP Servers
- Select the MCP server you want to restart
- Select the option to restart the server

### View Logs

To see MCP logs, check https://code.visualstudio.com/docs/copilot/chat/mcp-servers.

- Press `Cmd + Shift + P` and type List MCP Servers
- Select the MCP server you want to see logs for
- Select the option to view logs in the output panel

### Debugging

We can use @modelcontextprotocol/inspector to debug the server - https://github.com/modelcontextprotocol/inspector

From the root of this repository, run:

```shell
npx @modelcontextprotocol/inspector -- node dist/index.js
```

Or use the npm script:

```shell
npm run inspect
```

## 🛠️ Supported Tools

### Tool List
Expand Down Expand Up @@ -150,3 +117,7 @@ Step 3: Launch Claude Desktop and click on the hammer icon, the Demo MCP server
- Detailed instructions with screenshots can be found in this [document](https://docs.google.com/document/d/1_C8QBMZ5rwImV_9v4G96661OqcBk1n1SfEgKyNalv9c/edit?tab=t.2hhewstzj7ck#bookmark=id.nktw0lg0fn7t).

Note: If you make changes to your MCP server code, rebuild the project with `npm run build` and restart the server and Claude Desktop.

## 🤝 Contributing

Interested in contributing? Great! Please check our [Contributing Guide](CONTRIBUTING.md) for guidelines on code contributions, standards, adding new tools, and troubleshooting information.