Skip to content

Add Dockerfile and .dockerignore for Docker support #8

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 8 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
6 changes: 6 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
node_modules
npm-debug.log
.git
.gitignore
.DS_Store

23 changes: 23 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
FROM node:18

WORKDIR /app

# Copy only package.json files first
COPY package*.json ./

# Disable lifecycle scripts for install step
RUN npm install --ignore-scripts

# Copy the rest of the application code
COPY . .

# Manually run prepare now that code is present
RUN npm run prepare

# Create a non-root user
RUN addgroup --system --gid 1001 nodejs && \
adduser --system --uid 1001 nextjs

USER nextjs

CMD ["node", "build/index.js"]
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,20 @@ npx @michaellatman/mcp-get@latest install @llmindset/mcp-miro

_Note - if you are using an old version of Windows PowerShell, you may need to run_ `Set-ExecutionPolicy Bypass -Scope Process` _before this command._

### Running with Docker

To run the server in a Docker container, first build the image:

```bash
docker build -t mcp-miro .
```

Then, run the container, passing your MIRO OAuth key as an environment variable:

```bash
docker run -i --rm -e MIRO_OAUTH_TOKEN="YOUR-MIRO-OAUTH-TOKEN" mcp-miro
```

## Features

![MIRO/Claude Desktop Screenshot](./2024-12-02-screenshot_1.png)
Expand Down Expand Up @@ -82,6 +96,33 @@ On Windows: `%APPDATA%/Claude/claude_desktop_config.json`
}
```

### For Roo

To use with Roo, add the server configuration to your `mcp_servers.json` file.

On Linux/MacOS: `~/.config/roo/mcp_servers.json`
On Windows: `%APPDATA%/Roo/mcp_servers.json`

```json
{
"mcp-miro": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e", "MIRO_OAUTH_TOKEN",
"mcp-miro"
],
"env": {
"MIRO_OAUTH_TOKEN": "YOUR-MIRO-OAUTH-KEY"
},
"disabled": false,
"alwaysAllow": []
}
}
```

### Debugging

Since MCP servers communicate over stdio, debugging can be challenging. We recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector), which is available as a package script:
Expand Down