YuQue MCP

Servidor MCP YuQue

Servidor Model Context Protocol YuQue desenvolvido com base no componente MCP go-zero, fornecendo capacidades de operação de base de conhecimento YuQue para assistentes de IA.

Funcionalidades

• 🔍 Obter documento: Obtém o conteúdo detalhado do documento com base no ID da base de conhecimento e no ID do documento
• 📝 Criar documento: Cria um novo documento na base de conhecimento especificada
• ✏️ Atualizar documento: Modifica o título, conteúdo e outras informações do documento
• 🔎 Pesquisar documentos: Pesquisa documentos relevantes no YuQue
• 👤 Informações do usuário: Obtém informações detalhadas do usuário atual

Início rápido

1. Configurar variáveis de ambiente

export YUQUE_TOKEN="your_yuque_token_here"

2. Instalar dependências

go mod tidy

3. Iniciar o servidor

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

O servidor será iniciado em http://localhost:8080.

Ferramentas disponíveis

yuque_get_current_user

Obtém informações do usuário YuQue atual.

yuque_get_document

Obtém o conteúdo do documento especificado.

• book_id: ID ou caminho da base de conhecimento
• doc_id: ID do documento ou slug

yuque_create_document

Cria um novo documento.

• book_id: ID ou caminho da base de conhecimento
• title: Título do documento
• body: Conteúdo do documento (opcional)
• format: Formato do documento, padrão markdown
• public: Configuração de visibilidade, padrão 0 (privado)

yuque_update_document

Atualiza o conteúdo do documento.

• book_id: ID ou caminho da base de conhecimento
• doc_id: ID do documento ou slug
• title: Novo título (opcional)
• body: Novo conteúdo (opcional)
• format: Formato do documento (opcional)
• public: Configuração de visibilidade (opcional)

yuque_search_documents

Pesquisa documentos.

• query: Palavra-chave de pesquisa

Instruções de configuração

Arquivo de configuração 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 设置

Configuração de integração com Cursor IDE

Para usar este servidor MCP no Cursor IDE, é necessário adicionar a seguinte configuração nas configurações:

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

Etapas de configuração:

1. Abra as configurações do Cursor IDE
2. Pesquise por "MCP" ou "Model Context Protocol"
3. Adicione a configuração JSON acima
4. Altere o caminho cwd para o caminho real do projeto
5. Substitua YUQUE_TOKEN pelo seu Token de API do YuQue
6. Reinicie o Cursor IDE

Estrutura do projeto

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