Docmost

Primeiros passos

Para começar com o Raven Docs, consulte README-NEW.md para configuração e use a documentação do Raven Docs upstream como referência base.

Origem

O Raven Docs é construído sobre o código-fonte do Raven Docs e continua evoluindo com sua própria direção de produto.

Recursos

• Colaboração em tempo real
• Diagramas (Draw.io, Excalidraw e Mermaid)
• Espaços
• Gerenciamento de permissões
• Grupos
• Comentários
• Histórico de páginas
• Pesquisa
• Anexos de arquivos
• Incorporações (Airtable, Loom, Miro e mais)
• Traduções (10+ idiomas)
• Gerenciamento de projetos e tarefas
• Visualizações no estilo GTD de Inbox, Triagem, Aguardando, Algum dia e Revisão Semanal
• Notas diárias e captura de diário
• Integração de IA via Model Context Protocol (MCP) (extensão HaruHunab1320)

Integrações de API (Extensões HaruHunab1320)

Nota: As seguintes integrações de API são extensões desenvolvidas por HaruHunab1320 e não fazem parte do projeto upstream Raven Docs.

Master Control API (Interna)

O Raven Docs inclui uma API JSON-RPC 2.0 que alimenta o serviço padrão MCP internamente. Não é destinada a ser um endpoint público. A interface padrão MCP expõe as capacidades suportadas.

• Gerenciar espaços, páginas e comentários
• Administração de usuários e espaços de trabalho
• Gerenciamento de grupos
• Uploads de arquivos e anexos
• Navegação e controle da interface

A API padrão MCP é a interface pública suportada para agentes e ferramentas de automação.

Integração com Model Context Protocol (MCP)

Esta extensão implementa uma ponte entre o Raven Docs e assistentes de IA usando o Model Context Protocol.

O Raven Docs integra-se com assistentes de IA através do Model Context Protocol, permitindo que modelos de IA:

• Criar, ler, atualizar e excluir conteúdo
• Obter informações contextuais sobre espaços de trabalho, espaços e páginas
• Interagir com comentários
• Navegar pela interface
• Realizar tarefas de gerenciamento de usuários

Esta integração permite fluxos de trabalho assistidos por IA sem interrupções dentro da sua documentação e base de conhecimento.

Usando com Cursor

O Raven Docs expõe o protocolo MCP padrão diretamente em /api/mcp-standard, portanto nenhum processo de ponte separado é necessário:

1. Configure as configurações do seu Cursor para usar o servidor MCP integrado:

   {
     "mcpServers": {
       "raven-docs": {
         "url": "http://localhost:3000/api/mcp-standard",
         "apiKey": "your_api_key_here"
       }
     }
   }
   

2. Crie uma chave de API para o seu servidor Raven Docs:

   ./register-mcp-api-key.sh "Cursor MCP"
   

3. Use a chave de API gerada na sua configuração do Cursor.

4. Comece a usar as ferramentas diretamente do Cursor para interagir com o conteúdo do seu Raven Docs!

Ferramentas MCP Disponíveis

O serviço padrão MCP fornece as seguintes categorias de ferramentas:

Gerenciamento de Conteúdo

• space_create, space_list, space_update, space_delete: Gerenciar espaços
• page_create, page_list, page_update, page_delete, page_move: Gerenciar páginas
• comment_create, comment_list, comment_update, comment_delete: Gerenciar comentários
• attachment_upload, attachment_list, attachment_get, attachment_download, attachment_delete: Gerenciar anexos de arquivos

Gerenciamento de Usuários

• user_list, user_get, user_update: Gerenciar usuários
• group_create, group_list, group_update, group_delete, group_addMember, group_removeMember: Gerenciar grupos
• workspace_create, workspace_list, workspace_update, workspace_delete, workspace_addMember, workspace_removeMember: Gerenciar espaços de trabalho

Controle de UI

• ui_navigate: Navegar para destinos específicos na interface do Raven Docs

Cada ferramenta aceita parâmetros específicos e pode ser chamada diretamente de assistentes de IA que suportam o Model Context Protocol.

Capturas de Tela

Licença

O Raven Docs herda o núcleo do Raven Docs licenciado sob a licença de código aberto AGPL 3.0.
Recursos empresariais estão disponíveis sob uma licença empresarial (Enterprise Edition).

Todos os arquivos nos seguintes diretórios são licenciados sob a licença Enterprise do Raven Docs definida em packages/ee/License.

• apps/server/src/ee
• apps/client/src/ee
• packages/ee

Contribuindo

Consulte a documentação de desenvolvimento upstream