wiki-helper
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@wiki-helper search wiki content for 'JWT' and summarize the top results"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
mcp-wiki-helper-tools
MCP server for querying a Wiki stored in a Git repository.
It syncs the Wiki, indexes the Markdown files, and provides tools to list, search, and read documents in Codex or VS Code.
Features
Tool | What it does |
| Checks whether the MCP is working. |
| Lists the Wiki documents. |
| Searches by document name or path. |
| Searches within document content. |
| Reads a full Markdown document. |
Related MCP server: py-mcp-wiki-helper
How it works
The MCP clones or updates the Wiki's Git repository.
Finds all
.mdfiles.Creates an in-memory index.
Makes the tools available through the HTTP
/mcproute.Updates the Wiki periodically.
The folder defined in
WIKI_LOCAL_PATHis updated withgit reset --hard. Do not make manual changes to it, as they will be discarded.
1. Set up the server
On the machine where the MCP will run, enter the project folder:
cd "/caminho/para/mcp-wiki-helper"Install the dependencies:
npm installCreate the .env file:
cp .env.example .envFill in the .env:
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=/mcpTo make the first test easier on the local network, do not configure MCP_API_KEY.
2. Start the server
Compile:
npm run buildStart:
npm run start:httpKeep that terminal open. The expected message is:
[MCP] HTTP ativo em http://0.0.0.0:3000/mcpFind out the machine's IP:
hostname -IIf necessary, open the port on the local network:
sudo ufw allow from 192.168.0.0/16 to any port 3000 proto tcp3. Test the connection
On the other machine, run:
curl http://IP_DO_SERVIDOR:3000/healthExample:
curl http://192.168.3.233:3000/healthExpected response:
{
"status": "ok",
"documents": 100
}The documents field must be greater than zero.
4. Connect in Codex
In Codex:
Open Settings.
Go to MCP servers.
Click + Add server.
Choose the URL/HTTP type.
Use the name
wiki-helper.Fill in only the URL:
http://IP_DO_SERVIDOR:3000/mcpExample:
http://192.168.3.233:3000/mcpLeave these fields completely empty:
Bearer token env var
Headers
Headers from environment variables
Do not write none in the authentication fields.
Then:
Save the server.
Turn on the toggle next to
wiki-helper.Open a new conversation in Codex.
Send:
Use list_documents do MCP wiki-helper e mostre os primeiros 10 documentos.If Codex reports that the none environment variable does not exist:
Open Settings > MCP servers > wiki-helper.
Click Uninstall.
Add it again filling in only the URL.
Leave all authentication fields empty.
5. Connect in VS Code/Copilot
In VS Code:
Press
Ctrl+Shift+P.Run
MCP: Open User Configuration.Put it in the
mcp.jsonfile:
{
"servers": {
"wiki-helper": {
"type": "http",
"url": "http://IP_DO_SERVIDOR:3000/mcp"
}
}
}Then run MCP: List Servers, select wiki-helper, and choose Start Server.
6. Usage examples
Check the server:
Use a ferramenta Server do MCP wiki-helper.List documents:
Use list_documents do wiki-helper e mostre os primeiros 10 documentos.Search by name:
Use search_documents do wiki-helper para procurar "autenticação".Search within the Wiki:
Use search_content do wiki-helper para pesquisar "JWT", com limite 5.Read a document:
Use read_document do wiki-helper para ler "caminho/documento.md" e faça um resumo.Common issues
ECONNREFUSED ...:80 error
The URL is missing the port or the route. Always use:
http://IP_DO_SERVIDOR:3000/mcpThe /authorize route opened
The client tried to use OAuth. This MCP does not have OAuth. Remove the authentication and leave the Bearer and Headers fields empty.
The MCP does not connect
Check on the server machine:
npm run start:http
ss -lntp | grep 3000Test again on the client machine:
curl http://IP_DO_SERVIDOR:3000/healthThe Wiki does not return documents
Check whether the configured folder contains Markdown files:
find ./data/wiki -type f -name '*.md' | headAlso check access to the Git repository configured in WIKI_REPOSITORY_URL.
Security
Use this unauthenticated mode only on a controlled local network.
Do not expose port
3000directly to the internet.For external access, use HTTPS, authentication, and a reverse proxy.
Never commit keys or credentials in
.env.
Available Tools
5 toolslist_documentsList DocumentsB
Lista todos os documentos disponíveis na Wiki.
Inputs: no named parameters.
read_documentRead DocumentB
Lê o conteúdo de um documento da Wiki pelo caminho.
Inputs: path (required).
search_contentSearch Wiki ContentC
Pesquisa termos dentro do conteúdo dos documentos Markdown da Wiki.
Inputs: query (required), limit.
search_documentsSearch DocumentsC
Busca documentos da Wiki pelo nome ou caminho.
Inputs: query (required).
ServerServer checkA
Verifica se o servidor MCP está funcionando.
Inputs: no named parameters.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
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.
Search and manage your team's knowledge from MCP clients.
Read-only MCP server for the OrchestKit docs: full-text search + Markdown fetch. No auth.
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
- 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
- AlicenseNot gradedqualityBmaintenanceEnables MCP clients to maintain a persistent Markdown knowledge base by ingesting sources, searching and reading notes, and creating or updating wiki pages with optimistic locking.12AGPL 3.0