Skip to content

docs: add GitHub Copilot CLI installation instructions #1545

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.

Sign up for GitHub

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
GeekTrainer wants to merge 1 commit into
base: main
Choose a base branch
from
+42 −0
Open

docs: add GitHub Copilot CLI installation instructions #1545

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 42 additions & 0 deletions packages/markitdown-mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,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 `mcpinspector` tool.
Expand Down