Skip to content

Deployment: Dockerfile and Smithery config #260

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# MongoDB MCP Server

[![smithery badge](https://smithery.ai/badge/@mongodb-js/mongodb-mcp-server)](https://smithery.ai/server/@mongodb-js/mongodb-mcp-server)

A Model Context Protocol server for interacting with MongoDB Databases and MongoDB Atlas.

## 📚 Table of Contents
Expand Down Expand Up @@ -34,6 +36,14 @@ node -v

## Setup

### Installing via Smithery

To install MongoDB MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@mongodb-js/mongodb-mcp-server):

```bash
npx -y @smithery/cli install @mongodb-js/mongodb-mcp-server --client claude
```

### Quick Start

Most MCP clients require a configuration file to be created or modified to add the MCP server.
Expand Down
26 changes: 26 additions & 0 deletions smithery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Smithery configuration file: https://smithery.ai/docs/build/project-config

build:
dockerfile: Dockerfile
dockerBuildPath: ../
startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
properties:
connectionString:
type: string
description: The connection string to use to connect to MongoDB.
commandFunction:
# A JS function that produces the CLI command based on the given config to start the MCP on stdio.
|-
(config) => ({
"command": "node",
"args": [
"dist/index.js"
],
"env": {
"MDB_MCP_CONNECTION_STRING": config.connectionString
}
})
Loading