wiki-helper
mcp-wiki-helper-tools
用于查询存储在 Git 仓库中的 Wiki 的 MCP 服务器。
它会同步 Wiki、索引 Markdown 文件,并提供工具在 Codex 或 VS Code 中列出、搜索和阅读文档。
功能
工具 | 作用 |
| 检查 MCP 是否正常工作。 |
| 列出 Wiki 中的文档。 |
| 按文档名称或路径搜索。 |
| 在文档内容中搜索。 |
| 读取完整的 Markdown 文档。 |
Related MCP server: py-mcp-wiki-helper
工作原理
MCP 克隆或更新 Wiki 的 Git 仓库。
查找所有
.md文件。在内存中创建索引。
通过 HTTP 路由
/mcp提供工具。定期更新 Wiki。
WIKI_LOCAL_PATH定义的文件夹会通过git reset --hard更新。请勿手动修改该文件夹,否则更改将被丢弃。
1. 配置服务器
在运行 MCP 的机器上,进入项目文件夹:
cd "/caminho/para/mcp-wiki-helper"安装依赖:
npm install创建 .env 文件:
cp .env.example .env填写 .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=/mcp为了方便在本地网络中进行首次测试,请不要配置 MCP_API_KEY。
2. 启动服务器
编译:
npm run build启动:
npm run start:http保持该终端窗口打开。预期消息为:
[MCP] HTTP ativo em http://0.0.0.0:3000/mcp查找机器的 IP:
hostname -I如有必要,请在本地网络中开放端口:
sudo ufw allow from 192.168.0.0/16 to any port 3000 proto tcp3. 测试连接
在另一台机器上执行:
curl http://IP_DO_SERVIDOR:3000/health示例:
curl http://192.168.3.233:3000/health预期响应:
{
"status": "ok",
"documents": 100
}documents 字段应大于零。
4. 在 Codex 中连接
在 Codex 中:
打开 设置。
进入 MCP 服务器。
点击 + 添加服务器。
选择 URL/HTTP 类型。
使用名称
wiki-helper。仅填写 URL:
http://IP_DO_SERVIDOR:3000/mcp示例:
http://192.168.3.233:3000/mcp将以下字段完全留空:
Bearer token 环境变量
Headers
来自环境变量的 Headers
不要在认证字段中填写 none。
然后:
保存服务器。
启用
wiki-helper旁边的开关。在 Codex 中打开新对话。
发送:
Use list_documents do MCP wiki-helper e mostre os primeiros 10 documentos.如果 Codex 提示环境变量 none 不存在:
打开 设置 > MCP 服务器 > wiki-helper。
点击 卸载。
重新添加,仅填写 URL。
将所有认证字段留空。
5. 在 VS Code/Copilot 中连接
在 VS Code 中:
按
Ctrl+Shift+P。执行
MCP: Open User Configuration。在
mcp.json文件中添加:
{
"servers": {
"wiki-helper": {
"type": "http",
"url": "http://IP_DO_SERVIDOR:3000/mcp"
}
}
}然后执行 MCP: List Servers,选择 wiki-helper 并选择 Start Server。
6. 使用示例
检查服务器:
Use a ferramenta Server do MCP wiki-helper.列出文档:
Use list_documents do wiki-helper e mostre os primeiros 10 documentos.按名称搜索:
Use search_documents do wiki-helper para procurar "autenticação".在 Wiki 中搜索:
Use search_content do wiki-helper para pesquisar "JWT", com limite 5.读取文档:
Use read_document do wiki-helper para ler "caminho/documento.md" e faça um resumo.常见问题
错误 ECONNREFUSED ...:80
URL 缺少端口或路由。请始终使用:
http://IP_DO_SERVIDOR:3000/mcp打开了 /authorize 路由
客户端尝试使用 OAuth。此 MCP 不支持 OAuth。请移除认证,并将 Bearer 和 Headers 字段留空。
MCP 无法连接
在服务器机器上检查:
npm run start:http
ss -lntp | grep 3000在客户端机器上再次测试:
curl http://IP_DO_SERVIDOR:3000/healthWiki 不返回文档
检查配置的文件夹是否包含 Markdown 文件:
find ./data/wiki -type f -name '*.md' | head同时检查 WIKI_REPOSITORY_URL 中配置的 Git 仓库访问权限。
安全
仅在受控的本地网络中使用此无认证模式。
不要将
3000端口直接暴露到互联网。如需外部访问,请使用 HTTPS、认证和反向代理。
切勿在
.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.13AGPL 3.0