Apresentação do Projeto Scrapbox Cosense MCP Server

Visão Geral do Projeto

scrapbox-cosense-mcp é um servidor MCP (Model Context Protocol) projetado especificamente para a plataforma cosense/scrapbox. Desenvolvido por worldnine e hospedado no GitHub, este projeto visa fornecer uma interface padronizada para aplicações de IA com bases de conhecimento Scrapbox.

O Que é Scrapbox/Cosense?

Cosense é uma plataforma de gestão de conhecimento cuja filosofia central é "a chave para a produtividade reside no conhecimento". Permite aos utilizadores partilhar experiências, acumular conhecimento e alcançar facilmente o crescimento composto do conhecimento dentro de uma organização.

Funcionalidades Principais

1. get_page (Obter Página)

• Descrição da Funcionalidade: Obtém o conteúdo de uma página do cosense/Scrapbox.
• Parâmetros de Entrada: Título da página.
• Conteúdo de Saída: Conteúdo da página, metadados, informações de links e informações do editor.

2. list_pages (Listar Páginas)

• Descrição da Funcionalidade: Obtém a lista de páginas dentro de um projeto.
• Restrições: Retorna no máximo 1000 páginas.
• Conteúdo de Saída: Lista de títulos de todas as páginas dentro do projeto.

3. search_pages (Pesquisar Páginas)

• Descrição da Funcionalidade: Realiza uma pesquisa de texto completo dentro de um projeto.
• Capacidade de Pesquisa: Suporta pesquisa básica, pesquisa AND, pesquisa OR e pesquisa NOT.
• Restrições: Retorna no máximo 100 resultados de pesquisa.
• Conteúdo de Saída: Lista de títulos de páginas que correspondem aos critérios de pesquisa.

4. create_pages (Criar Páginas)

• Descrição da Funcionalidade: Gera um URL de página.
• Parâmetros de Entrada: Título da página e conteúdo do corpo opcional.
• Conteúdo de Saída: URL que pode ser aberto num navegador.

Instalação e Configuração

Instalação para Desenvolvimento Local

# Clonar o projeto
git clone https://github.com/worldnine/scrapbox-cosense-mcp.git
cd scrapbox-cosense-mcp

# Instalar dependências
npm install

# Construir o servidor
npm run build

# Reconstrução automática durante o desenvolvimento
npm run watch

Configuração para Integração com Claude Desktop

Para usar este servidor no Claude Desktop, é necessário adicionar as configurações do servidor no ficheiro de configuração:

Caminho do Ficheiro de Configuração no macOS:

~/Library/Application\ Support/Claude/claude_desktop_config.json

Caminho do Ficheiro de Configuração no Windows:

%APPDATA%/Claude/claude_desktop_config.json

Exemplo de Configuração:

{
  "mcpServers": {
    "scrapbox-cosense-mcp": {
      "command": "npx",
      "args": ["github:worldnine/scrapbox-cosense-mcp"],
      "env": {
        "COSENSE_PROJECT_NAME": "nome_do_seu_projeto",
        "COSENSE_SID": "seu_sid",
        "COSENSE_PAGE_LIMIT": "25",
        "COSENSE_SORT_METHOD": "created",
        "SERVICE_LABEL": "scrapbox(cosense)"
      }
    }
  }
}

Descrição das Variáveis de Ambiente

Variáveis Obrigatórias

• COSENSE_PROJECT_NAME: Nome do projeto (obrigatório)
  • Se não for definido, o servidor irá sair com um erro ao iniciar.

Variáveis Opcionais

• COSENSE_SID: ID da sessão de autenticação do Scrapbox/Cosense

  • Necessário para aceder a projetos privados.
  • Se não for definido, apenas é possível aceder a projetos públicos.

• API_DOMAIN: Domínio da API (padrão: "scrapbox.io")

  • Fornece uma opção para ambientes que podem precisar de usar "cosen.se".

• SERVICE_LABEL: Identificador do serviço (padrão: "cosense (scrapbox)")

• COSENSE_PAGE_LIMIT: Limite inicial de obtenção de páginas (padrão: 100)

  • Intervalo válido: 1-1000
  • Se estiver fora do intervalo, o valor padrão é usado automaticamente.

• COSENSE_SORT_METHOD: Ordem inicial de obtenção de páginas (padrão: "updated")

  • Valores opcionais: updated/created/accessed/linked/views/title
  • Apenas afeta a obtenção inicial de recursos, não afeta a ferramenta list_pages.

Ferramentas de Depuração

Como o servidor MCP comunica através de stdio, a depuração pode ser difícil. O projeto recomenda o uso do MCP Inspector para depuração:

npm run inspector

O Inspector fornecerá um URL que pode ser acedido num navegador para usar as ferramentas de depuração.

Características do Projeto

1. Interface Padronizada: Este servidor facilita a interação com projetos cosense/Scrapbox, permitindo aos utilizadores recuperar, listar, pesquisar e criar páginas, ao mesmo tempo que suporta várias operações de consulta e acesso seguro a projetos privados.

2. Segurança: Suporta o acesso a projetos privados através de um ID de sessão, garantindo a segurança dos dados.

3. Configuração Flexível: Fornece várias opções de variáveis de ambiente para se adaptar a diferentes cenários de uso.

4. Amigável ao Desenvolvimento: Fornece reconstrução automática no modo de desenvolvimento e ferramentas de depuração dedicadas.

Casos de Uso

• Automação da Gestão de Conhecimento: Integra o Scrapbox para implementar funcionalidades de leitura e escrita de páginas para gestão de conhecimento, notas colaborativas e aplicações de chatbot.
• Melhoria do Assistente de IA: Fornece às aplicações de IA a capacidade de aceder a bases de conhecimento estruturadas.
• Otimização da Recuperação de Conteúdo: Recupera e pesquisa eficientemente o conteúdo do Scrapbox através de uma API padronizada.
• Integração de Ferramentas de Colaboração: Integra as funcionalidades de colaboração do Scrapbox noutras ferramentas de IA.

Arquitetura Técnica

Este projeto é baseado na arquitetura Model Context Protocol, onde os desenvolvedores podem expor dados através de um servidor MCP ou construir aplicações de IA (clientes MCP). O projeto é desenvolvido usando Node.js e TypeScript, seguindo as especificações do protocolo padrão MCP.

Resumo

scrapbox-cosense-mcp é uma implementação completa de um servidor MCP, fornecendo uma forma padronizada para aplicações de IA interagirem com bases de conhecimento Scrapbox. Não só suporta operações básicas de página, como também fornece poderosas funcionalidades de pesquisa e acesso seguro a projetos privados, tornando-se uma ferramenta ideal para construir sistemas inteligentes de gestão de conhecimento.