diff --git a/packages/markitdown-mcp/README.md b/packages/markitdown-mcp/README.md index d7e9224b4..029eb243f 100644 --- a/packages/markitdown-mcp/README.md +++ b/packages/markitdown-mcp/README.md @@ -98,6 +98,48 @@ If you want to mount a directory, adjust it accordingly: } ``` +## Accessing from GitHub Copilot CLI + +Edit your `~/.copilot/mcp-config.json` to include the following JSON entry: + +```json +{ + "mcpServers": { + "markitdown": { + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "markitdown-mcp:latest" + ] + } + } +} +``` + +If you want to mount a directory, adjust it accordingly: + +```json +{ + "mcpServers": { + "markitdown": { + "command": "docker", + "args": [ + "run", + "--rm", + "-i", + "-v", + "/home/user/data:/workdir", + "markitdown-mcp:latest" + ] + } + } +} +``` + +For more information, see the [GitHub Copilot CLI documentation](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp). + ## Debugging To debug the MCP server you can use the `MCP Inspector` tool.