YuQue MCP

Un servidor MCP para interactuar con la base de conocimiento de YuQue, que permite a los asistentes de IA realizar operaciones sobre documentos e información.

GitHub
5
Prueba este MCPPatrocinado

Documentación

Servidor MCP de YuQue

Servidor Model Context Protocol de YuQue desarrollado con el componente MCP de go-zero, que proporciona capacidades de operación de la base de conocimientos de YuQue para asistentes de IA.

Características

  • 🔍 Obtener documento: Obtiene el contenido detallado de un documento según el ID de la base de conocimientos y el ID del documento
  • 📝 Crear documento: Crea un nuevo documento en la base de conocimientos especificada
  • ✏️ Actualizar documento: Modifica el título, contenido y otra información del documento
  • 🔎 Buscar documentos: Busca documentos relevantes en YuQue
  • 👤 Información del usuario: Obtiene la información detallada del usuario actual

Inicio rápido

1. Configurar variables de entorno

export YUQUE_TOKEN="your_yuque_token_here"

2. Instalar dependencias

go mod tidy

3. Iniciar el servidor

go run cmd/server/main.go -f config.yaml

El servidor se iniciará en http://localhost:8080.

Herramientas disponibles

yuque_get_current_user

Obtiene la información del usuario actual de YuQue.

yuque_get_document

Obtiene el contenido del documento especificado.

  • book_id: ID o ruta de la base de conocimientos
  • doc_id: ID o slug del documento

yuque_create_document

Crea un nuevo documento.

  • book_id: ID o ruta de la base de conocimientos
  • title: Título del documento
  • body: Contenido del documento (opcional)
  • format: Formato del documento, por defecto markdown
  • public: Configuración de visibilidad, por defecto 0 (privado)

yuque_update_document

Actualiza el contenido del documento.

  • book_id: ID o ruta de la base de conocimientos
  • doc_id: ID o slug del documento
  • title: Nuevo título (opcional)
  • body: Nuevo contenido (opcional)
  • format: Formato del documento (opcional)
  • public: Configuración de visibilidad (opcional)

yuque_search_documents

Busca documentos.

  • query: Palabra clave de búsqueda

Instrucciones de configuración

Archivo de configuración config.yaml:

name: yuque-mcp-server
host: localhost
port: 8080
mcp:
  name: yuque-mcp-server
  messageTimeout: 30s
  cors:
    - http://localhost:3000

yuque:
  baseUrl: "https://www.yuque.com/api/v2"
  # token 通过环境变量 YUQUE_TOKEN 设置

Configuración de integración con Cursor IDE

Para usar este servidor MCP en Cursor IDE, debe agregar la siguiente configuración en los ajustes:

{
  "mcpServers": {
    "yuque": {
      "command": "go",
      "args": ["run", "cmd/server/main.go", "-f", "config.yaml"],
      "cwd": "/path/to/YuQueMCP",
      "env": {
        "YUQUE_TOKEN": "your_yuque_token_here"
      }
    }
  }
}

Pasos de configuración:

  1. Abra la configuración de Cursor IDE
  2. Busque "MCP" o "Model Context Protocol"
  3. Agregue la configuración JSON anterior
  4. Cambie la ruta cwd a la ruta real del proyecto
  5. Reemplace YUQUE_TOKEN con su token de API de YuQue
  6. Reinicie Cursor IDE

Estructura del proyecto

├── cmd/server/          # 服务器启动入口
├── internal/
│   ├── config/         # 配置相关
│   ├── server/         # MCP服务器逻辑
│   │   └── tools/      # 工具实现
│   └── yuque/          # 语雀API客户端
├── config.yaml         # 配置文件
└── go.mod             # Go模块文件