
talosdeus/wiki-js-mcp
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
talosdeus/wiki-js-mcp - кандидат на сервер MCP, импортированный из https://github.com/talosdeus/wiki-js-mcp.
Обзор
talosdeus/wiki-js-mcp - кандидат на сервер MCP, импортированный из https://github.com/talosdeus/wiki-js-mcp.
Обзор (машинный перевод)
Комплексный сервер Model Context Protocol (MCP) для интеграции с иерархической документацией и развертывания Docker. Идеально подходит для организаций, управляющих несколькими хранилищами и крупномасштабной документацией.
Быстрый старт
###1 - Окружающая среда
Во-первых, клонируйте это хранилище и настройте переменные среды:
###2 Развертывание докера (рекомендуется)
Wiki.js будет доступен по адресу http://localhost:3000
Заполните начальную настройку в веб-интерфейсе
###3 Настройка MCP-сервера
###4 Настройка курсора MCP Добавьте к своему [1]:
##Усовершенствованная интеграция курсоров
Глобальные правила документооборота
Добавьте эти ** Глобальные правила** в Курсор, чтобы автоматически использовать документацию перед кодированием:
Эти правила гарантируют, что ваш помощник ИИ: Проверьте документацию, прежде чем предлагать реализации Следуйте существующим шаблонам и конвенциям Поддерживать актуальную документацию автоматически Создание структурированной документации для новых функций Избегайте дублирования существующей функциональности
Советы по использованию курсора
Ключевые особенности
** Иерархическая документация**
Эта страница переведена автоматически. Технические детали смотрите в оригинале.
README
Показан фрагмент оригинального README. Открыть оригинал.
Wiki.js MCP Server
A comprehensive Model Context Protocol (MCP) server for Wiki.js integration with hierarchical documentation support and Docker deployment. Perfect for organizations managing multiple repositories and large-scale documentation.
🚀 Quick Start
1. Environment Setup
First, clone this repository and set up environment variables:
# Copy environment template
cp config/example.env .env
# Edit .env with your credentials:
# - Set POSTGRES_PASSWORD to a secure password
# - Update other settings as needed
2. Docker Deployment (Recommended)
# Start Wiki.js with Docker
docker-compose -f docker.yml up -d
Wiki.js will be available at http://localhost:3000
Complete the initial setup in the web interface
3. Setup MCP Server
# Install Python dependencies
./setup.sh
# Update .env with Wiki.js API credentials:
# - Get API key from Wiki.js admin panel
# - Set WIKIJS_TOKEN in .env file
# Test the connection
./test-server.sh
# Start MCP server
# (not needed for AI IDEs like Cursor, simply click on the refresh icon after editing mcp.json
# and you should see a green dot with all tools listed. In existing open Cursor windows,
# this refresh is necessary in order to use this MCP)
./start-server.sh
4. Configure Cursor MCP
Add to your ~/.cursor/mcp.json:
{
"mcpServers": {
"wikijs": {
"command": "/path/to/wiki-js-mcp/start-server.sh"
}
}
}
🎯 Enhanced Cursor Integration
Global Rules for Documentation-First Development
Add these Global Rules in Cursor to automatically leverage documentation before coding:
Before writing any code, always:
1. Search existing documentation using wikijs_search_pages to understand current patterns and architecture
2. Check for related components, functions, or modules that might already exist
3. If documentation exists for similar functionality, follow the established patterns and naming conventions
4. If no documentation exists, create it using wikijs_create_page or wikijs_create_nested_page before implementing
5. Always update documentation when making changes using wikijs_sync_file_docs
6. For new features, use wikijs_create_repo_structure to plan the documentation hierarchy first
These rules ensure that your AI assistant will:
- ✅ Check documentation before suggesting implementations
- ✅ Follow existing patterns and conventions
- ✅ Maintain up-to-date documentation automatically
- ✅ Create structured documentation for new features
- ✅ Avoid duplicating existing functionality
Usage Tips for Cursor
# Before starting a new feature
"Search the documentation for authentication patterns before implementing login"
# When creating components
"Create nested documentation under frontend-app/components before building the React component"
# For API development
"Check existing API documentation and create endpoint docs using the established structure"
# During refactoring
Установка
This server does not publish a one-line install command.
Open the repository installation guide Новичок в MCP? Начните с руководства на mcpskill.org →Конфигурация
{
"mcpServers": {
"wikijs": {
"command": "/path/to/wiki-js-mcp/start-server.sh"
}
}
}