wiki-helper
mcp-wiki-helper-tools
MCP-Server zum Abfragen eines Wikis, das in einem Git-Repository gespeichert ist.
Er synchronisiert das Wiki, indexiert die Markdown-Dateien und bietet Werkzeuge zum Auflisten, Durchsuchen und Lesen von Dokumenten in Codex oder VS Code.
Funktionen
Werkzeug | Was es tut |
| Prüft, ob der MCP funktioniert. |
| Listet die Dokumente des Wikis auf. |
| Sucht nach Name oder Pfad des Dokuments. |
| Sucht im Inhalt der Dokumente. |
| Liest ein vollständiges Markdown-Dokument. |
Related MCP server: py-mcp-wiki-helper
So funktioniert es
Der MCP klont oder aktualisiert das Git-Repository des Wikis.
Er findet alle
.md-Dateien.Er erstellt einen Index im Speicher.
Er stellt die Werkzeuge über die HTTP-Route
/mcpbereit.Er aktualisiert das Wiki regelmäßig.
Der in
WIKI_LOCAL_PATHdefinierte Ordner wird mitgit reset --hardaktualisiert. Nehmen Sie keine manuellen Änderungen daran vor, da diese verworfen werden.
1. Server konfigurieren
Auf dem Rechner, auf dem der MCP laufen soll, wechseln Sie in den Projektordner:
cd "/caminho/para/mcp-wiki-helper"Installieren Sie die Abhängigkeiten:
npm installErstellen Sie die Datei .env:
cp .env.example .envFüllen Sie die .env aus:
WIKI_REPOSITORY_URL=git@github.com:empresa/wiki.git
WIKI_LOCAL_PATH=./data/wiki
WIKI_BRANCH=main
WIKI_SYNC_INTERVAL_MS=1800000
MCP_HTTP_HOST=0.0.0.0
MCP_HTTP_PORT=3000
MCP_HTTP_ROUTE=/mcpUm den ersten Test im lokalen Netzwerk zu erleichtern, konfigurieren Sie MCP_API_KEY nicht.
2. Server starten
Kompilieren:
npm run buildStarten:
npm run start:httpLassen Sie dieses Terminal geöffnet. Die erwartete Meldung ist:
[MCP] HTTP ativo em http://0.0.0.0:3000/mcpErmitteln Sie die IP des Rechners:
hostname -IFalls erforderlich, geben Sie den Port im lokalen Netzwerk frei:
sudo ufw allow from 192.168.0.0/16 to any port 3000 proto tcp3. Verbindung testen
Führen Sie auf dem anderen Rechner aus:
curl http://IP_DO_SERVIDOR:3000/healthBeispiel:
curl http://192.168.3.233:3000/healthErwartete Antwort:
{
"status": "ok",
"documents": 100
}Das Feld documents muss größer als null sein.
4. In Codex verbinden
In Codex:
Öffnen Sie Settings.
Gehen Sie zu MCP servers.
Klicken Sie auf + Add server.
Wählen Sie den Typ URL/HTTP.
Verwenden Sie den Namen
wiki-helper.Füllen Sie nur die URL aus:
http://IP_DO_SERVIDOR:3000/mcpBeispiel:
http://192.168.3.233:3000/mcpLassen Sie diese Felder vollständig leer:
Bearer token env var
Headers
Headers from environment variables
Schreiben Sie nicht none in die Authentifizierungsfelder.
Danach:
Speichern Sie den Server.
Aktivieren Sie den Schalter neben
wiki-helper.Öffnen Sie eine neue Unterhaltung in Codex.
Senden Sie:
Use list_documents do MCP wiki-helper e mostre os primeiros 10 documentos.Wenn Codex meldet, dass die Umgebungsvariable none nicht existiert:
Öffnen Sie Settings > MCP servers > wiki-helper.
Klicken Sie auf Uninstall.
Fügen Sie ihn erneut hinzu, indem Sie nur die URL ausfüllen.
Lassen Sie alle Authentifizierungsfelder leer.
5. In VS Code/Copilot verbinden
In VS Code:
Drücken Sie
Ctrl+Shift+P.Führen Sie
MCP: Open User Configurationaus.Fügen Sie in die Datei
mcp.jsonein:
{
"servers": {
"wiki-helper": {
"type": "http",
"url": "http://IP_DO_SERVIDOR:3000/mcp"
}
}
}Führen Sie dann MCP: List Servers aus, wählen Sie wiki-helper und wählen Sie Start Server.
6. Beispiele für die Verwendung
Server überprüfen:
Use a ferramenta Server do MCP wiki-helper.Dokumente auflisten:
Use list_documents do wiki-helper e mostre os primeiros 10 documentos.Nach Namen suchen:
Use search_documents do wiki-helper para procurar "autenticação".Im Wiki suchen:
Use search_content do wiki-helper para pesquisar "JWT", com limite 5.Ein Dokument lesen:
Use read_document do wiki-helper para ler "caminho/documento.md" e faça um resumo.Häufige Probleme
Fehler ECONNREFUSED ...:80
Die URL hat keinen Port oder keine Route. Verwenden Sie immer:
http://IP_DO_SERVIDOR:3000/mcpRoute /authorize geöffnet
Der Client hat versucht, OAuth zu verwenden. Dieser MCP hat kein OAuth. Entfernen Sie die Authentifizierung und lassen Sie die Felder Bearer und Headers leer.
Der MCP verbindet nicht
Überprüfen Sie auf dem Server-Rechner:
npm run start:http
ss -lntp | grep 3000Testen Sie erneut auf dem Client-Rechner:
curl http://IP_DO_SERVIDOR:3000/healthDas Wiki gibt keine Dokumente zurück
Überprüfen Sie, ob der konfigurierte Ordner Markdown-Dateien enthält:
find ./data/wiki -type f -name '*.md' | headÜberprüfen Sie auch den Zugriff auf das in WIKI_REPOSITORY_URL konfigurierte Git-Repository.
Sicherheit
Verwenden Sie diesen Modus ohne Authentifizierung nur in einem kontrollierten lokalen Netzwerk.
Setzen Sie den Port
3000nicht direkt im Internet aus.Verwenden Sie für externen Zugriff HTTPS, Authentifizierung und einen Reverse-Proxy.
Versionieren Sie niemals Schlüssel oder Anmeldedaten in der
.env.
Available Tools
5 toolslist_documentsList DocumentsB
Lista todos os documentos disponíveis na Wiki.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
read_documentRead DocumentB
Lê o conteúdo de um documento da Wiki pelo caminho.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | Caminho do documento, por exemplo: "software/JWT.md" |
search_contentSearch Wiki ContentC
Pesquisa termos dentro do conteúdo dos documentos Markdown da Wiki.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Quantidade máxima de documentos retornados. | |
| query | Yes | Termos que devem ser pesquisados na Wiki. |
search_documentsSearch DocumentsC
Busca documentos da Wiki pelo nome ou caminho.
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Texto para pesquisar. |
ServerServer checkA
Verifica se o servidor MCP está funcionando.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
5 tool updates
v1.0.0- First observed
list_documents - First observed
read_document - First observed
search_content - First observed
search_documents - First observed
Server
TDQS
Scored across 5 tools
Each tool has a clear, distinct purpose: health check, list all documents, read by path, search by name/path, and search content. No overlap or ambiguity exists among the tool operations.
Most tools follow a consistent verb_noun pattern (list_documents, read_document, search_documents, search_content). The lone exception is 'Server,' which is a single-word health check and slightly breaks the pattern, but it remains readable and predictable.
At 5 tools, the server is well-scoped for a wiki helper. Each tool covers a fundamental operation without redundancy or bloat, and the count is within the ideal 3-15 range.
The surface provides list, read, and two search capabilities, covering the primary read-only workflows for a wiki. It lacks create/update/delete operations, but these may be intentionally out of scope for a helper; minor gaps exist but are easily worked around by external tools.
Maintenance
Related MCP Connectors
Shared project wiki for AI agents: read and write pages, next actions, and activity logs over MCP.
Hosted markdown project wikis your team's AI assistants read, search, and update over MCP.
Read-only MCP server for the OrchestKit docs: full-text search + Markdown fetch. No auth.
Read and write your team's shared, AI-readable wiki from any MCP client.
Related MCP Servers
- FlicenseNot gradedqualityCmaintenanceServes markdown knowledge from a git repository over MCP, providing tools to list, search, and retrieve documents.-
- AlicenseNot gradedqualityCmaintenanceMCP server to query a Git-hosted Wiki, offering tools to list, search, and read Markdown documents via Codex or VS Code.MIT
- FlicenseNot gradedqualityDmaintenanceProvides structured search, schema-validated writes, and linting for a markdown knowledge base, enabling agents to operate the wiki over a single streamable-HTTP MCP endpoint.1-
- AlicenseNot gradedqualityCmaintenanceEnables read-only searching, reading, and status inspection of a local Git-backed Markdown wiki via a minimal MCP toolset, without any network or write operations.Apache 2.0