Log inSubmit server
Markdown MCP Resource logo

Markdown MCP Resource

Exposes remote Markdown files as MCP resources from a JSON index, with listing, path completion, retrieval, and in-memory caching.

InstallRepositoryWebsite
Full README Compare alternatives Embed widget Claim this listing

Install Markdown MCP Resource

Pick your client, then add it in one click or paste the config.

STDIONode.js
~/Library/Application Support/Claude/claude_desktop_config.json
claude_desktop_config.json
{
  "mcpServers": {
    "markdown-mcp-resource": {
      "command": "npx",
      "args": [
        "-y",
        "markdown-mcp-resource@latest"
      ]
    }
  }
}

Settings → Developer → Edit Config, merge this into mcpServers, then fully quit and reopen Claude Desktop.

Install not yet sandbox-tested— we haven't run this command through our automated sandbox yet. Not a red flag; we're working through the catalog.

Overview

markdown-mcp-resource turns a remote Markdown documentation set into MCP resources that compatible clients can browse and read. It accepts an HTTP(S) URL for an index.json file, resolves each listed route, and exposes resources using markdown:// URIs. Clients can list files, complete resource paths, and retrieve Markdown content directly. Reach for it when documentation is hosted remotely and should be available to an AI assistant without copying files into the local project.

Use cases

  • Expose hosted product documentation to an MCP client
  • Browse a remote Markdown knowledge base
  • Retrieve API guides from a JSON-indexed documentation site
  • Organize documentation resources in nested paths

Key features

  • Remote index.json discovery
  • Markdown resource listing
  • Direct content retrieval
  • Resource path completion
  • In-memory content caching
  • Nested subdirectory support

Security & health

What it can reach and how reliably it runs — from our own checks, not the maintainer’s claims.

ActiveLast checked 2d ago

Recent health check succeeded.

Supply-chain signal

No high-severity advisories surfaced by our automated scan.

Critical 0High 0Medium 0Low 0

Scanned 6d ago via OSV.dev · markdown-mcp-resource@latest (npm)

Adoption & maintenance

Factual signals from GitHub, npm, and our automated checks — not a rating.

npm downloads448Package downloads in the last 30 days.
Last commit2d agoMost recent push to the default branch.

How Markdown MCP Resource works

What markdown-mcp-resource does

markdown-mcp-resource publishes remote Markdown documentation through the Model Context Protocol. A documentation host supplies an index.json file containing named entries and routes to individual .md files. The server reads that index and presents the listed documents as MCP resources for an AI client.

Resource identifiers use the form markdown://{hostname}/{filename}. Names can represent nested paths such as api/authentication or tutorials/basic-setup, allowing a documentation collection to retain a directory-like structure while remaining hosted on a web server.

The server is intended for read access. It discovers files from the index, fetches their Markdown content, and makes that content available to the connected MCP client.

How it works

Start the process with the complete URL of the remote index file as its command-line argument. The index must contain a files array. Each entry provides a name and a route:

  • name identifies the resource and should omit the .md suffix.
  • route points to the Markdown file and must include its .md suffix.
  • Routes may be absolute HTTP(S) URLs or root-relative paths beginning with /.

Root-relative routes resolve against the origin of the index URL, rather than against the directory containing index.json. Relative forms such as ./docs/file.md are not supported.

After loading the index, the server supports resource discovery, path completion, and direct content retrieval. Fetched content is cached in memory for the duration of the session, which can avoid repeated network requests for the same document.

Setup and configuration

The package can be run through npx with the @latest tag:

Terminal
npx markdown-mcp-resource@latest https://docs.example.com/index.json

For Claude Desktop, add a server entry whose command is npx and whose arguments are -y, markdown-mcp-resource@latest, and the full index URL. OpenCode can use a local MCP entry with the same command and URL. Other MCP clients can launch the command using their standard local or stdio server configuration.

The remote site should expose an accessible index.json and each Markdown URL named in its files array. A minimal index can include a title, description, and entries such as getting-started mapped to an absolute Markdown URL. Before connecting a client, the index and individual files can be checked with curl.

Tools and capabilities

  • Lists the Markdown resources declared by the remote index.
  • Retrieves the contents of a selected Markdown resource.
  • Provides completion for resource paths.
  • Supports nested documentation names and subdirectories.
  • Caches downloaded content in memory during a session.
  • Handles missing files and network-related fetch failures without requiring local document copies.

Limitations and notes

The index URL must begin with http:// or https:// and point to an index.json file. The index needs a files array, and its names should not include .md. Every referenced file must be reachable at the route supplied by the index.

Because documents are fetched remotely, the hosting site must serve the index and Markdown files correctly. Browser-based deployments may also need suitable CORS configuration. HTTP caching headers on the documentation host can help with repeated access, while the server's own content cache lasts only for the active session.

The project is distributed under the MIT license. Local development uses npm install, followed by npm run build; the built server can then be started with an index URL.

Read the full README View source on GitHub

Reviews

No reviews yet — be the first to share how it worked for you.

Frequently Asked Questions about Markdown MCP Resource

markdown-mcp-resource is an MCP server that connects MCP-compatible clients to remote Markdown documentation indexed by a JSON file. Its main capabilities are listing available resources, completing resource paths, and retrieving file content directly. It fetches the listed files over HTTP(S) and keeps fetched content in memory during the session.

Run it with npx and pass the full URL of a remote index.json file: `npx markdown-mcp-resource@latest https://docs.example.com/index.json`. You can place the same command and URL in an MCP client's local server configuration.

The index must contain a `files` array with `name` and `route` values for each Markdown document. Names omit `.md`, while routes include it and must be either absolute HTTP(S) URLs or root-relative paths beginning with `/`.

Absolute routes are fetched directly, while root-relative routes resolve against the origin of the index URL. Path-relative values such as `./docs/file.md` are unsupported, and each referenced Markdown file must be available at its resolved URL.

It caches fetched Markdown content in memory during the active session. This can reduce repeated network requests while the MCP server remains running; HTTP caching headers on the hosting site can also help with access performance.

Related MCP servers

All in File Systems All alternatives
Add a badge to your READMEShow it’s listed — live SVG, Markdown or HTML.

AllMCPs Directory Badge

Full Badge Customizer

Showcase your server listing on GitHub or your project documentation. Embed this dynamic SVG badge to highlight official listing status and live engagement.

Badge Style:
Live Dynamic SVG PreviewMarkdown MCP Resource AllMCPs Directory Badge
Markdown (GitHub README)
[![AllMCPs](https://allmcps.com/api/badge/markdown-mcp-resource?style=directory)](https://allmcps.com/mcp/markdown-mcp-resource)
HTML Embed
<a href="https://allmcps.com/mcp/markdown-mcp-resource"><img src="https://allmcps.com/api/badge/markdown-mcp-resource?style=directory" alt="Markdown MCP Resource on AllMCPs" /></a>