-
Notifications
You must be signed in to change notification settings - Fork 50
Added instructions for running in Docker without a Git checkout #17
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -92,9 +92,38 @@ A Model Context Protocol (MCP) server that provides tools for interacting with T | |
|
||
## Installation | ||
|
||
### Quick Start with pnpx (Recommended) | ||
### 1. Getting a Trello API key | ||
|
||
The easiest way to use the Trello MCP server is with `pnpx`, which doesn't require a global install: | ||
To connect a Trello workspace, you'll need to configure a Power Up (no code required), and get its API key and token. | ||
|
||
1. Go to [trello.com/power-ups/admin](https://trello.com/power-ups/admin). Click _New_, and fill out the form. You can leave _Iframe connector URL_ blank. | ||
2. Click on _Generate a new API key_. You can leave the _Allowed origins_ field blank; it would be used for an OAuth user login flow, but we don't need it. | ||
3. Copy the _API key_ — you'll need it to set up the client (below) | ||
4. Next to _API key_ should be some text along the lines of: | ||
|
||
> If you are looking to build an application for yourself, or are doing local testing, you can manually generate a **Token**. | ||
|
||
**Token** should be a link like this: | ||
|
||
``` | ||
https://trello.com/1/authorize?expiration=never&name=YOUR_APP_NAME&scope=read,write&response_type=token&key=YOUR_API_KEY | ||
``` | ||
|
||
Click on it to get your token. | ||
|
||
5. ~~Ignore the _Secret_: it's different from the token, and it's not needed.~~ | ||
|
||
This will generate the token required for integration. | ||
|
||
> [!NOTE] | ||
> The `expiration=never` parameter creates a token that does not expire. For enhanced security, consider using `expiration=30days` and renewing the token periodically if your setup allows for it. | ||
|
||
### 2. Quick Start for Claude Desktop | ||
|
||
1. Configure Claude Desktop to start the Trello MCP server | ||
2. Restart Claude Desktop. | ||
|
||
An easy way to use the Trello MCP server is with `pnpx`, which doesn't require a global install. Add the `mcpServers.trello` entry to your [Claude Desktop config file](https://modelcontextprotocol.io/quickstart/user#installing-the-filesystem-server): | ||
|
||
```json | ||
{ | ||
|
@@ -128,22 +157,33 @@ Or if you're using mise: | |
} | ||
``` | ||
|
||
To connect a Trello workspace, you'll need to manually retrieve a `TRELLO_TOKEN` once per workspace. After setting up your Trello Power-Up, visit the following URL: | ||
Or with Docker: | ||
|
||
```json | ||
{ | ||
"mcpServers": { | ||
"trello": { | ||
"command": "docker", | ||
"args": [ | ||
"run", "-i", "--rm", | ||
"--volume=npx-cache-20:/root/.npm", | ||
"--volume=node-modules-cache-20:/root/.cache", | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [nitpick] Similar to the npm cache volume, 'node-modules-cache-20' includes a hardcoded version number that should be consistent with the Node.js version. Consider adding a comment explaining the version alignment or using a more generic naming pattern. Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback
Comment on lines
+169
to
+170
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using version-specific names for the Docker volumes (e.g., |
||
"--env=TRELLO_API_KEY", | ||
"--env=TRELLO_TOKEN", | ||
"node:20-alpine", | ||
"npx", | ||
"@delorenj/mcp-server-trello" | ||
], | ||
"env": { | ||
"TRELLO_API_KEY": "your-api-key", | ||
"TRELLO_TOKEN": "your-token" | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
https://trello.com/1/authorize?expiration=never&name=YOUR_APP_NAME&scope=read,write&response_type=token&key=YOUR_API_KEY | ||
``` | ||
|
||
Replace: | ||
|
||
* `YOUR_APP_NAME` with a name for your application (e.g., "My Trello Integration"). This name is shown to the user on the Trello authorization screen. | ||
* `YOUR_API_KEY` with the API key for your Trello Power-Up | ||
|
||
This will generate the token required for integration. | ||
|
||
> [!NOTE] | ||
> The `expiration=never` parameter creates a token that does not expire. For enhanced security, consider using `expiration=30days` and renewing the token periodically if your setup allows for it. | ||
|
||
After adding that to your configuration, quit and reopen Claude Desktop. It should start the server automatically, and you should see "trello" listed under _Search and tools_ in the chat interface. | ||
|
||
#### Don't have pnpm? | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The volume name 'npx-cache-20' includes a hardcoded version number '20' that should match the Node.js version used in the container. Consider using a more descriptive name or documenting why this specific version is included.
Copilot uses AI. Check for mistakes.