Skip to content

docs(mcp): add pip-based Claude Desktop config #2172

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
wali-reheman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(mcp): add pip-based Claude Desktop config #2172

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
24 changes: 20 additions & 4 deletions packages/markitdown-mcp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,27 @@ Once mounted, all files under data will be accessible under `/workdir` in the co

## Accessing from Claude Desktop

It is recommended to use the Docker image when running the MCP server for Claude Desktop.
Follow [these instructions](https://modelcontextprotocol.io/quickstart/user#for-claude-desktop-users) to access Claude's `claude_desktop_config.json` file, then add the appropriate entry for your setup.

Follow [these instructions](https://modelcontextprotocol.io/quickstart/user#for-claude-desktop-users) to access Claude's `claude_desktop_config.json` file.
### Using pip

Edit it to include the following JSON entry:
If you installed `markitdown-mcp` via pip, add this to your Claude Desktop config:

```json
{
"mcpServers": {
"markitdown": {
"command": "markitdown-mcp"
}
}
}
```

To access local files, pass `file:` URIs to the `convert_to_markdown` tool — for example, `file:///home/user/data/example.txt`.

### Using Docker

If you prefer Docker, the recommended configuration is:

```json
{
Expand All @@ -78,7 +94,7 @@ Edit it to include the following JSON entry:
}
```

If you want to mount a directory, adjust it accordingly:
To mount a local directory, adjust accordingly:

```json
{
Expand Down