io.github.groupdocs-markdown/groupdocs-markdown-mcp
MCP server for GroupDocs.Markdown — convert documents to Markdown via AI agents.
Open source Open in the app JSON README (API)
About
MCP server for GroupDocs.Markdown — convert documents to Markdown via AI agents.
Details
- Kind
- MCP servers
- Topic
- Files & documents
- Publisher
- groupdocs-markdown
- Origin
- official
- Category
- ferramentas
- Transport
- local
- Version
- 26.9.0
- Last push
- 2026-09-04T18:52:14Z
- Repository state
- ativo
- Language
- C#
- License
- MIT
- Added
- 2026-08-29 03:02:54
- Updated
- 2026-09-04 19:00:53
- Origin id
io.github.groupdocs-markdown/groupdocs-markdown-mcp
README
# GroupDocs.Markdown MCP Server
MCP server that exposes [GroupDocs.Markdown](https://products.groupdocs.com/markdown) as AI-callable tools
for Claude, Cursor, GitHub Copilot, and other MCP agents — convert documents to clean, structured Markdown.
[](https://www.nuget.org/packages/GroupDocs.Markdown.Mcp)
[](https://www.nuget.org/packages/GroupDocs.Markdown.Mcp)
[](https://hub.docker.com/r/groupdocs/markdown-net-mcp)
[](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.groupdocs-markdown/groupdocs-markdown-mcp)
[](https://github.com/groupdocs-markdown/GroupDocs.Markdown.Mcp.Tests/actions/workflows/integration.yml)
[](LICENSE)
<!-- TODO(manual): record 30s demo per improvement-plan M1 -->
<!--  -->
## Installation
<!-- install-buttons:start - generated by install/generate-install-links.ps1; do not edit by hand -->
[](https://vscode.dev/redirect/mcp/install?name=groupdocs-markdown&config=%7B%22command%22%3A%22dnx%22%2C%22args%22%3A%5B%22GroupDocs.Markdown.Mcp%22%2C%22--yes%22%5D%2C%22env%22%3A%7B%22GROUPDOCS_MCP_STORAGE_PATH%22%3A%22%2Fpath%2Fto%2Fdocuments%22%2C%22GROUPDOCS_MCP_OUTPUT_PATH%22%3A%22%2Fpath%2Fto%2Fdocuments%22%2C%22GROUPDOCS_LICENSE_PATH%22%3A%22%22%7D%7D) [](https://insiders.vscode.dev/redirect/mcp/install?name=groupdocs-markdown&config=%7B%22command%22%3A%22dnx%22%2C%22args%22%3A%5B%22GroupDocs.Markdown.Mcp%22%2C%22--yes%22%5D%2C%22env%22%3A%7B%22GROUPDOCS_MCP_STORAGE_PATH%22%3A%22%2Fpath%2Fto%2Fdocuments%22%2C%22GROUPDOCS_MCP_OUTPUT_PATH%22%3A%22%2Fpath%2Fto%2Fdocuments%22%2C%22GROUPDOCS_LICENSE_PATH%22%3A%22%22%7D%7D&quality=insiders) [](https://cursor.com/en/install-mcp?name=groupdocs-markdown&config=eyJjb21tYW5kIjoiZG54IiwiYXJncyI6WyJHcm91cERvY3MuTWFya2Rvd24uTWNwIiwiLS15ZXMiXSwiZW52Ijp7IkdST1VQRE9DU19NQ1BfU1RPUkFHRV9QQVRIIjoiL3BhdGgvdG8vZG9jdW1lbnRzIiwiR1JPVVBET0NTX01DUF9PVVRQVVRfUEFUSCI6Ii9wYXRoL3RvL2RvY3VtZW50cyIsIkdST1VQRE9DU19MSUNFTlNFX1BBVEgiOiIifX0%3D) [](install/generated/codex.md) [](install/generated/windsurf.md)
> One-click installs pre-fill every supported setting: edit the placeholder documents
> folder after install (output defaults to the same folder); an empty
> GROUPDOCS_LICENSE_PATH runs in evaluation mode - point it at your license to lift limits.
>
> **More clients** - ready-made configs for Claude Code, Codex CLI, Visual Studio 2022,
> Cursor, Windsurf, Cline, and JetBrains Rider live in [`install/generated/`](install/generated/).
<!-- install-buttons:end -->
Requires [.NET 10 SDK](https://dotnet.microsoft.com/download/dotnet/10.0).
**Run directly with `dnx` (recommended — no install step):**
```bash
dnx GroupDocs.Markdown.Mcp --yes
```
Pulls the latest stable release on every invocation. To pin to a specific
version (recommended for shared configs and CI), append `@<version>`:
```bash
dnx GroupDocs.Markdown.Mcp@26.9.0 --yes
```
**Or install as a global dotnet tool:**
```bash
dotnet tool install -g GroupDocs.Markdown.Mcp
groupdocs-markdown-mcp
```
**Or run via Docker:**
```bash
docker run --rm -i \
-v $(pwd)/documents:/data \
ghcr.io/groupdocs-markdown/markdown-net-mcp:latest
```
No native prerequisites are required on any platform — the underlying
GroupDocs.Markdown engine renders image-bearing documents through a
self-contained SkiaSharp native asset, so `dnx`, the global tool, and the
Docker image all run with no extra `apt`/`brew` setup.
## Available MCP Tools
| Tool | Description |
|---|---|
| `ConvertToMarkdown` | Converts a document (PDF, DOCX, XLSX, EPUB, MOBI, …) to clean, structured Markdown and saves the `.md` to storage. Images embed as base64 by default. |
| `GetDocumentInfo` | Returns file format, page count, title, author, and encryption flag as JSON, without converting. |
> Reverse Markdown → document composition is **not yet implemented** in the
> underlying GroupDocs.Markdown 26.3.0 engine (`MarkdownConverter.FromMarkdownString`
> throws `NotImplementedException`), so this server does **not** expose a
> `ComposeFromMarkdown` tool. Use the
> [GroupDocs.Conversion MCP](https://www.nuget.org/packages/GroupDocs.Conversion.Mcp)
> with a `.md` source file if you need Markdown → DOCX / PDF / HTML output today.
## Example prompts for AI agents
- "Convert report.pdf to Markdown"
- "Export business-plan.docx as Markdown with images embedded as base64"
- "Convert pages 1-3 of contract.pdf to Markdown, text only — skip images"
- "How many pages does business-plan.pdf have?"
- "What format and author does cost-analysis.xlsx have?"
## Licensing
**The MCP server itself is MIT; the underlying GroupDocs.Markdown engine requires a license
for production use.** Without one the server runs in **evaluation mode**:
- Output may be limited and carries an evaluation notice.
- A single server process can open at most **15 documents**; further calls fail with an evaluation-cap error until the server restarts.
There are two ways to license the server.
**License file** — point `GROUPDOCS_LICENSE_PATH` at your `GroupDocs.Total.lic`. Works offline.
**Metered (pay-per-use)** — set both `GROUPDOCS_METERED_PUBLIC_KEY` and
`GROUPDOCS_METERED_PRIVATE_KEY`. You are billed for what you actually process, which suits AI
agents well because their usage is bursty and hard to predict up front. If both a metered key pair
and a license file are configured, **metered wins** and the file is ignored.
> **Metered mode needs outbound connectivity.** Usage is reported to GroupDocs servers, so
> air-gapped or firewalled deployments must allow that egress — or use a license file instead.
Call the **`get_license_status`** tool at any time to see which mode is active, and — under
metered — the consumed quantity and remaining credit.
### Keeping the private key out of your config
The metered private key is a secret. MCP client configs are plain files on disk, and a
project-scoped `.mcp.json` is committed by convention, so prefer, in order:
1. **Set the variables in your OS environment and leave them out of the config entirely.** An
stdio MCP server inherits its client's environment, so this works in every client.
On macOS note that an app launched from Finder does not inherit shell exports — use
`launchctl setenv`, or launch the client from a terminal.
2. **Reference them indirectly** if your client supports it (Claude Code expands `${VAR}`;
VS Code uses `${env:VAR}` and `${input:...}`).
3. **A literal value in a user-scoped config** (for example `~/.claude.json`) is acceptable for a
single developer.
4. **Never** commit a literal key in a project-scoped `.mcp.json`.
For Docker, forward the values without writing them into any file:
```bash
docker run --rm -i \
-e GROUPDOCS_METERED_PUBLIC_KEY -e GROUPDOCS_METERED_PRIVATE_KEY \
-v /path/to/documents:/data \
ghcr.io/groupdocs-markdown/markdown-net-mcp:latest
```
To lift the limits with a license file:
- [Get a free 30-day temporary license](https://purchase.groupdocs.com/temporary-license/)
- [Purchase a license](https://purchase.groupdocs.com/pricing/markdown/net) | [Product page](https://products.groupdocs.com/markdown/net/)
## Configuration
| Variable | Description | Default |
|---|---|---|
| `GROUPDOCS_MCP_STORAGE_PATH` | Base folder for input and output files | current directory |
| `GROUPDOCS_MCP_OUTPUT_PATH` | *(Optional)* separate folder for output files | `GROUPDOCS_MCP_STORAGE_PATH` |
| `GROUPDOCS_LICENSE_PATH` | Path to GroupDocs license file | (evaluation mode) |
| `GROUPDOCS_METERED_PUBLIC_KEY` | Metered public key. Requires the private key too; takes precedence over the license file | (unset) |
| `GROUPDOCS_METERED_PRIVATE_KEY` | Metered private key. **Secret** - see [Licensing](#licensing) | (unset) |
In evaluation mode (no license) the converted Markdown may be limited and can
include an evaluation notice. Supply `GROUPDOCS_LICENSE_PATH` for unrestricted
output.
## Usage with Claude Desktop
```json
{
"mcpServers": {
"groupdocs-markdown": {
"type": "stdio",
"command": "dnx",
"args": ["GroupDocs.Markdown.Mcp", "--yes"],
"env": {
"GROUPDOCS_MCP_STORAGE_PATH": "/path/to/documents"
}
}
}
}
```
> To pin to a specific version, replace `"GroupDocs.Markdown.Mcp"` with
> `"GroupDocs.Markdown.Mcp@26.9.0"` in `args`. Pinning is recommended for
> shared / committed configs to avoid surprise upgrades.
## Usage with VS Code / GitHub Copilot
NuGet.org generates a ready-to-use `mcp.json` snippet on the [package page](https://www.nuget.org/packages/GroupDocs.Markdown.Mcp).
Copy it directly into your `.vscode/mcp.json`.
Alternatively, add manually to `.vscode/mcp.json`:
```json
{
"inputs": [
{
"type": "promptString",
"id": "storage_path",
"description": "Base folder for input and output files.",
"password": false
}
],
"servers": {
"groupdocs-markdown": {
"type": "stdio",
"command": "dnx",
"args": ["GroupDocs.Markdown.Mcp", "--yes"],
"env": {
"GROUPDOCS_MCP_STORAGE_PATH": "${input:storage_path}"
}
}
}
}
```
> Same pinning rule as above — swap `"GroupDocs.Markdown.Mcp"` for
> `"GroupDocs.Markdown.Mcp@26.9.0"` to lock to a specific release.
## Usage with Docker Compose
```bash
cd docker
docker compose up
```
Edit `docker/docker-compose.yml` to point volumes at your local documents folder.
## Documentation & guides
Step-by-step deployment guides and a published-package integration test suite
live in the companion repo
[**GroupDocs.Markdown.Mcp.Tests**](https://github.com/groupdocs-markdown/GroupDocs.Markdown.Mcp.Tests):
- [Install from NuGet](https://github.com/groupdocs-markdown/GroupDocs.Markdown.Mcp.Tests/blob/master/how-to/01-install-from-nuget.md) — `dnx`, global tool, pinned vs always-latest
- [Run via Docker](https://github.com/groupdocs-markdown/GroupDocs.Markdown.Mcp.Tests/blob/master/how-to/02-run-via-docker.md)
- [Verify on the MCP registry](https://github.com/groupdocs-markdown/GroupDocs.Markdown.Mcp.Tests/blob/master/how-to/03-verify-mcp-registry.md)
- [Use with Claude Desktop](https://github.com/groupdocs-markdown/GroupDocs.Markdown.Mcp.Tests/blob/master/how-to/04-use-with-claude-desktop.md)
- [Use with VS Code / GitHub Copilot](https://github.com/groupdocs-markdown/GroupDocs.Markdown.Mcp.Tests/blob/master/how-to/05-use-with-vscode-copilot.md)
- [Run the integration tests](https://github.com/groupdocs-markdown/GroupDocs.Markdown.Mcp.Tests/blob/master/how-to/06-run-integration-tests.md)
That repo also exercises every advertised tool against the **published** NuGet
artifact on Linux, macOS, and Windows in CI — so the snippets above are
verified end-to-end on every release.
## License
MIT — see [LICENSE](LICENSE)
<!-- mcp-name: io.github.groupdocs-markdown/groupdocs-markdown-mcp -->