-
Notifications
You must be signed in to change notification settings - Fork 21
Update README.md #54
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
Merged
Merged
Update README.md #54
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
943855f
Update README.md
akinard-postman 5aff6cd
Update README.md
akinard-postman 9fe7be2
Update README.md
akinard-postman bf292a3
Update README.md
akinard-postman 4f1f2a7
Update README.md
akinard-postman dee6943
Update README.md
akinard-postman c3a1de4
Update DOCKER.md
akinard-postman 5617fd1
Update README.md
akinard-postman 02fc20e
Update README.md
akinard-postman 5fc951b
Update README.md
akinard-postman d1c8a2e
Update README.md
akinard-postman 57262d4
Update README.md
akinard-postman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,15 @@ | ||
# Docker Build Instructions | ||
# Docker installation | ||
|
||
This project uses a multi-stage Docker build to create a STDIO version of the application. | ||
This project uses a multi-stage Docker build to create a local Postman MCP Server. | ||
|
||
## Building with Docker | ||
## Installation | ||
|
||
Run the following command to build with Docker: | ||
To use the Postman MCP Server in Docker, you can use one of the following methods: | ||
|
||
```bash | ||
docker build -t postman-api-mcp-stdio . | ||
``` | ||
* To install the Postman MCP Server in Docker, see the [Postman MCP Server](https://hub.docker.com/mcp/server/postman/overview) at Docker MCP Hub. Click **+ Add to Docker Desktop** to automatically install it. | ||
|
||
## Running the Docker container | ||
* To run the Postman MCP Server image in Docker, run the `docker run -i -e POSTMAN_API_KEY="<your-secret-key>" mcp/postman` command in your terminal. Docker automatically discovers, downloads, and runs the Postman MCP Server image. | ||
|
||
Select from the following modes to run the Docker container: | ||
|
||
### Minimal mode - 37 Tools (Default) | ||
|
||
This default mode is designed to stay within VS Code's 128 tool limit when combined with other MCP servers. It provides 37 essential tools for common Postman operations: | ||
|
||
```bash | ||
docker run -i -e POSTMAN_API_KEY="<your-secret-key>" postman-api-mcp-stdio | ||
``` | ||
|
||
### Full Mode - 106 Tools | ||
|
||
This mode includes all 106 available tools with the `--full` flag: | ||
|
||
```bash | ||
docker run -i -e POSTMAN_API_KEY="<your-secret-key>" postman-api-mcp-stdio --full | ||
``` | ||
* To build and run the server in Docker manually, run the `docker build -t postman-api-mcp-stdio .` command. Then, run one of the following commands, replacing `$YOUR-POSTMAN-API-KEY` with your Postman API key: | ||
* **Minimal** - `docker run -i -e POSTMAN_API_KEY="<your-secret-key>" postman-api-mcp-stdio` | ||
* **Full** - `docker run -i -e POSTMAN_API_KEY="<your-secret-key>" postman-api-mcp-stdio --full` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.