Ermöglicht es KI-Assistenten, auf entfernte Markdown-Dokumentationen über eine JSON-Indexdatei zuzugreifen und diese zu lesen.
Auch bekannt als pawcoding/markdown-mcp-resource
- Stars
- 0
- Tools
- —
- Downloads, 30 Tage
- —
- Neueste Version
- —
- Letzter Commit
- 7. Nov. 2026
- Lizenz
- MIT
Was ist markdown-mcp-resource MCP?
markdown-mcp-resource ist ein MCP server. Ermöglicht es KI-Assistenten, auf entfernte Markdown-Dokumentationen über eine JSON-Indexdatei zuzugreifen und diese zu lesen.
Zusammenfassung generiert aus dem README des Projekts
Über markdown-mcp-resource MCP server
Die Hauptfunktion dieses Servers besteht darin, KI-Assistenten direkten Zugriff auf entfernte Dokumentationen zu geben. Er ermöglicht es Entwicklern, eine Sammlung von Markdown-Dateien, die auf einem Webserver gehostet werden, in einen strukturierten Satz von MCP resources zu verwandeln. Indem man den Server auf eine entfernte JSON-Indexdatei verweist, kann ein KI-Client spezifische Dokumentationsdateien über ein spezielles URI-Pattern entdecken, auflisten und lesen.
Nutzer richten den Server lokal via npx ein, indem sie die Basis-URL zu einer index.json Datei als Argument in der Kommandozeile angeben. Diese Konfiguration funktioniert mit Clients wie Claude Desktop oder OpenCode. Der Server verwaltet die Verbindung zu deiner Dokumentationsseite, übernimmt das Abrufen der Markdown-Inhalte und nutzt In-Memory-Caching, um einen schnelleren Zugriff während einer Session zu gewährleisten. Er unterstützt komplexe Dokumentationsstrukturen, einschließlich verschachtelter Unterverzeichnisse und root-relativer Pfade, was ihn ideal für umfangreiche technische Handbücher macht.
Was du damit machen kannst
- 1Verfügbare Dokumentationen entdeckenFrage die KI, alle Dokumentationsdateien aufzulisten, die aktuell indiziert und lesbar sind.
- 2Spezifische Guides lesenFordere den Assistenten auf, den vollständigen Text eines spezifischen Installations- oder Konfigurationsguides abzurufen und anzuzeigen.
Geschrieben aus dem README des Projekts. Jeder Use Case wurde gegen ein Zitat daraus geprüft.
So installierst du markdown-mcp-resource MCP
Formate geprüft am 10. Nov. 2026Zu Cursor hinzufügenZu Goose hinzufügenmarkdown-mcp-resource MCP in Claude Code installieren
$ claude mcp add markdown-mcp-resource -- npx -y markdown-mcp-resourcemarkdown-mcp-resource MCP in Cursor installieren
~/.cursor/mcp.json
{
"mcpServers": {
"markdown-mcp-resource": {
"command": "npx",
"args": [
"-y",
"markdown-mcp-resource"
]
}
}
}markdown-mcp-resource MCP in VS Code installieren
.vscode/mcp.json
{
"servers": {
"markdown-mcp-resource": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"markdown-mcp-resource"
]
}
}
}markdown-mcp-resource MCP in VS Code CLI installieren
$ code --add-mcp '{"name":"markdown-mcp-resource","type":"stdio","command":"npx","args":["-y","markdown-mcp-resource"]}'markdown-mcp-resource MCP in Claude Desktop installieren
claude_desktop_config.json
{
"mcpServers": {
"markdown-mcp-resource": {
"command": "npx",
"args": [
"-y",
"markdown-mcp-resource"
]
}
}
}markdown-mcp-resource MCP in Codex installieren
$ codex mcp add markdown-mcp-resource -- npx -y markdown-mcp-resourcemarkdown-mcp-resource MCP in Codex config.toml installieren
~/.codex/config.toml
[mcp_servers.markdown-mcp-resource] command = "npx" args = ["-y", "markdown-mcp-resource"]
markdown-mcp-resource MCP in Gemini CLI installieren
$ gemini mcp add -s user markdown-mcp-resource npx -- -y markdown-mcp-resourcemarkdown-mcp-resource MCP in Gemini settings.json installieren
~/.gemini/settings.json
{
"mcpServers": {
"markdown-mcp-resource": {
"command": "npx",
"args": [
"-y",
"markdown-mcp-resource"
]
}
}
}Automatisierte Checks
Geluften am 15. Nov. 2026Vollständiger Bericht →Unsere automatisierten Checks bestanden. Das ist kein Security-Audit: Lies den Code und gib dem Server nur den minimal notwendigen Zugriff. Wie die Checks funktionieren
- Source Repository verknüpft und erreichbarpawcoding/markdown-mcp-resource is public and reachablegithub.com/pawcoding/markdown-mcp-resource ↗Bestanden
- Paket nennt dieses Repository als Quellemarkdown-mcp-resource names pawcoding/markdown-mcp-resource as sourcenpmjs.com/package/markdown-mcp-resource ↗Bestanden
- Build-Provenienz (Sigstore-Attestierung)Sigstore attestation for markdown-mcp-resourcenpmjs.com/package/markdown-mcp-resource/v/1.2.3#provenance ↗Bestanden
- Open Source Lizenz (OSI)MITspdx.org/licenses/MIT.html ↗Bestanden
- Commit oder Release im letzten JahrLast commit or release 2026-11-07github.com/pawcoding/markdown-mcp-resource ↗Bestanden
- OpenSSF ScorecardNicht geprüft
- Package-Name ähnelt keinem populären PackageNo popular package one edit away from markdown-mcp-resourceBestanden
- Keine kritischen Advisories im Paket oder seinen AbhängigkeitenNicht geprüft
- Keine versteckten Anweisungen an das Modell0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersBestanden
- Destruktive Tools sind markiertNicht geprüft
- Remote-Endpoint beantwortet den MCP-HandshakeNicht geprüft
README
Auf GitHub ansehenmarkdown-mcp-resource
MCP server that makes remote markdown files available as MCP resources.
Overview
This MCP (Model Context Protocol) server enables AI assistants to access and read markdown documentation from remote URLs. It fetches markdown files listed in a remote JSON index file and makes them available as resources that can be queried and retrieved by MCP-compatible clients.
How It Works
The server:
- Takes a base URL to a JSON index file as a command-line argument (e.g.,
https://my-documentation.com/mcp/index.json) - Expects the index file to contain a list of available markdown files and their routes
- Exposes these files as MCP resources with the URI pattern
markdown://{hostname}/{filename} - Caches fetched content in memory to improve performance
- Provides both resource listing, path completion, and direct content retrieval capabilities
Remote Asset Structure
Your documentation site must be structured as follows:
Required: index.json File
Schema Reference:
The expected format for index.json is formally described in the schema.json file in this repository.
The base URL must point to an index.json file that lists all available markdown files and their routes. Routes can be full HTTP(S) URLs or root-relative paths that start with /, for example:
{
"$schema": "https://raw.githubusercontent.com/pawcoding/markdown-mcp-resource/refs/heads/master/schema.json",
"title": "My Documentation",
"description": "Example documentation index",
"files": [
{
"name": "getting-started",
"route": "https://your-site.com/docs/getting-started.md"
},
{
"name": "api-reference",
"route": "https://your-site.com/docs/api-reference.md"
},
{
"name": "tutorials/basic-setup",
"route": "/docs/tutorials/basic-setup.md"
},
{
"name": "tutorials/advanced-config",
"route": "/docs/tutorials/advanced-config.md"
},
{
"name": "troubleshooting",
"route": "/docs/troubleshooting.md"
}
]
}
Markdown Files
Each file listed in the index must be available at the URL specified in the route field. Root-relative routes resolve against the origin of the index file URL, not the path of the index file:
https://your-site.com/docs/
├── index.json # Lists all available files and their routes
├── getting-started.md # Individual markdown files
├── api-reference.md
├── tutorials/
│ ├── basic-setup.md
│ └── advanced-config.md
└── troubleshooting.md
Important Notes:
- File names in the
namefield of the index should NOT include the.mdextension; theroutefield must be a full HTTP(S) URL or root-relative path to the markdown file and include the.mdextension - Root-relative routes must start with
/; path-relative routes such asdocs/getting-started.mdor./docs/getting-started.mdare not supported - Subdirectories are supported (e.g.,
tutorials/basic-setup)
MCP Client Configuration
OpenCode Configuration
Add this to your OpenCode configuration file (replace with the full URL to your index.json):
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-documentation": {
"type": "local",
"command": [
"npx",
"-y",
"markdown-mcp-resource@latest",
"https://my-documentation.com/mcp/index.json"
],
"enabled": true
}
}
}
Claude Desktop Configuration
Add this to your Claude Desktop configuration (replace with the full URL to your index.json):
{
"mcpServers": {
"markdown-docs": {
"command": "npx",
"args": [
"-y",
"markdown-mcp-resource@latest",
"https://your-documentation-site.com/docs/index.json"
]
}
}
}
Generic MCP Client
For other MCP clients, use the command (replace with the full URL to your index.json):
npx markdown-mcp-resource@latest https://your-documentation-site.com/docs/index.json
Usage Examples
1. Setting Up Documentation
Create an index.json file on your web server:
{
"$schema": "https://raw.githubusercontent.com/pawcoding/markdown-mcp-resource/refs/heads/master/schema.json",
"files": [
{
"name": "introduction",
"route": "https://yoursite.com/docs/introduction.md"
},
{
"name": "installation",
"route": "https://yoursite.com/docs/installation.md"
},
{
"name": "configuration",
"route": "/docs/configuration.md"
},
{
"name": "api/authentication",
"route": "/docs/api/authentication.md"
},
{
"name": "api/endpoints",
"route": "/docs/api/endpoints.md"
},
{ "name": "examples", "route": "/docs/examples.md" },
{
"name": "troubleshooting",
"route": "/docs/troubleshooting.md"
}
]
}
Ensure corresponding markdown files exist:
https://yoursite.com/docs/introduction.mdhttps://yoursite.com/docs/installation.mdhttps://yoursite.com/docs/api/authentication.md- etc.
2. Querying Available Resources
Once configured, your MCP client can:
- List all available markdown resources
- Retrieve specific markdown content
- Search through available documentation files
3. Example Interaction
User: "What documentation is available?"
Assistant: [Lists all files from index.json]
User: "Show me the installation guide"
Assistant: [Retrieves and displays installation.md content]
Features
- Resource Discovery: Automatically lists available documentation from
index.json - Content Caching: Improves performance by caching fetched markdown files
- Path Completion: Supports auto-completion of file paths
- Error Handling: Graceful handling of missing files or network issues
- Subdirectory Support: Organize documentation in nested folders
Troubleshooting
Common Issues
Error: "Invalid base path"
- Ensure the base URL starts with
http://orhttps://and points to yourindex.json - Example:
https://docs.example.com/index.jsonnotdocs.example.com
No resources found
- Verify
index.jsonexists at the base URL - Check that
index.jsoncontains afilesarray with file names and routes - Ensure file names in the
namefield don't include.mdextension
Failed to fetch file
- Verify the markdown files exist at the expected URLs
- Check for CORS issues if accessing from browser environments
- Ensure proper HTTP headers are set on your web server
Performance Issues
- Consider enabling HTTP caching headers on your web server
- The MCP server caches content in memory during the session
Testing Your Setup
-
Verify your
index.jsonis accessible:curl https://your-site.com/docs/index.json -
Test individual markdown files:
curl https://your-site.com/docs/getting-started.md -
Run the MCP server directly:
npx markdown-mcp-resource@latest https://your-site.com/docs/index.json -
Use the MCP Inspector for interactive testing:
Visit https://modelcontextprotocol.io/legacy/tools/inspector to test your MCP server interactively in a web interface.
Development
Local Development
git clone https://github.com/pawcoding/markdown-mcp-resource.git
cd markdown-mcp-resource
npm install
npm run build
npm start https://your-test-site.com/docs/index.json
Visit https://modelcontextprotocol.io/legacy/tools/inspector to test your MCP server interactively in a web interface.
Building
npm run build
Formatting
npm run format
License
MIT - see LICENSE file for details.
markdown-mcp-resource MCP Fragen
Wie füge ich markdown-mcp-resource MCP zu Claude Code hinzu?
Führe claude mcp add markdown-mcp-resource -- npx -y markdown-mcp-resource in deinem Terminal aus. Füge --scope user hinzu, damit der Server in jedem Projekt verfügbar ist.
Wie füge ich markdown-mcp-resource MCP zu Cursor hinzu?
Öffne ~/.cursor/mcp.json und füge den Server unter mcpServers hinzu, mit der Cursor-Config aus dem Installationsabschnitt oben.
Wie konfiguriere ich den Server für Claude Desktop?
Füge den Server zu deiner Claude Desktop Konfiguration hinzu, indem du npx verwendest und die vollständige URL zu deiner index.json Datei angibst.
Welche Struktur muss die Indexdatei haben?
Die index.json Datei muss ein 'files' Array enthalten, wobei jedes Objekt einen 'name' (ohne .md) und eine 'route' (eine vollständige URL oder ein root-relativer Pfad) besitzt.
Unterstützt der Server Unterverzeichnisse?
Ja, der Server unterstützt die Organisation von Dokumentationen in verschachtelten Ordnern und Unterverzeichnissen.
Wie geht der Server mit der Performance um?
Der Server verbessert die Performance, indem er die abgerufenen Markdown-Inhalte im Arbeitsspeicher cached.