Skip to content

Commit

Permalink
Add Smithery CLI Installation Instructions (#2)
Browse files Browse the repository at this point in the history
* Add Smithery installation badge and instructions

* Organize README.md

---------

Co-authored-by: Muhammed Kılıç <[email protected]>
  • Loading branch information
calclavia and kiliczsh authored Dec 13, 2024
1 parent 38a213d commit b3e8797
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
![NPM Version](https://img.shields.io/npm/v/mcp-mongo-server)
![NPM Downloads](https://img.shields.io/npm/dm/mcp-mongo-server)
![NPM License](https://img.shields.io/npm/l/mcp-mongo-server)
[![smithery badge](https://smithery.ai/badge/mcp-mongo-server)](https://smithery.ai/protocol/mcp-mongo-server)

A Model Context Protocol server that provides access to MongoDB databases. This server enables LLMs to inspect collection schemas and execute read-only queries.

Expand Down Expand Up @@ -103,14 +104,6 @@ The server provides schema information for each collection in the database:
- Automatically inferred from collection documents


## Using mcp-get

You can install this package using mcp-get:

```bash
npx @michaellatman/mcp-get@latest install mcp-mongo-server
```

## Usage with Claude Desktop

To use this server with the Claude Desktop app, add the following configuration to the "mcpServers" section of your `claude_desktop_config.json`:
Expand All @@ -130,6 +123,22 @@ To use this server with the Claude Desktop app, add the following configuration
}
```

### Installing via Smithery

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

```bash
npx @smithery/cli install mcp-mongo-server --client claude
```

### Installing via mcp-get

You can install this package using mcp-get:

```bash
npx @michaellatman/mcp-get@latest install mcp-mongo-server
```

Replace `/sample_namespace` with your database name.

## License
Expand Down

0 comments on commit b3e8797

Please sign in to comment.