Follow Plan

Acompanhe e gerencie planos de implementação de IA.

GitHubExperimente este MCPPatrocinado

Documentação

Servidor MCP Follow Plan

Um servidor abrangente de Model Context Protocol (MCP) para planejamento inteligente de projetos e gerenciamento de tarefas com persistência SQLite e recursos de pesquisa em texto completo.

Recursos

  • Gerenciamento de Tarefas: Crie, atualize e acompanhe tarefas com status, prioridade e progresso
  • Planejamento de Funcionalidades: Gerencie histórias de usuário, épicos e especificações de funcionalidades
  • Rastreamento de Bugs: Reporte e acompanhe bugs com níveis de severidade e etapas de reprodução
  • Mecanismo de Regras: Defina regras de projeto, validações e diretrizes de automação
  • Pesquisa em Texto Completo: Pesquisa avançada em todos os itens do plano com pontuação de relevância
  • Armazenamento SQLite: Armazenamento persistente com indexação de pesquisa em texto completo FTS5
  • Sincronização Automática: Sincronização automática entre banco de dados e sistema de arquivos
  • Backup/Restauração: Funcionalidade de backup e restauração do banco de dados

Início Rápido

1. Instalar Dependências

npm install

2. Compilar o Projeto

npm run build

3. Iniciar o Servidor MCP

npm start /path/to/your/project

O servidor criará um diretório .plan no seu projeto com a seguinte estrutura:

.plan/
├── database.db          # SQLite database
├── index.md            # Project overview
├── tasks/              # Task files
├── features/           # Feature files
├── bugs/               # Bug files
├── rules/              # Rule files
├── workflows/          # Workflow documentation
├── changelog/          # Project changelog
└── tmp/                # Temporary files and logs

Ferramentas MCP

Gerenciamento de Tarefas

  • create_task - Criar uma nova tarefa
  • update_task - Atualizar uma tarefa existente
  • get_task - Obter detalhes da tarefa por ID
  • list_tasks - Listar tarefas com filtros opcionais
  • delete_task - Excluir uma tarefa

Gerenciamento de Funcionalidades

  • create_feature - Criar uma nova funcionalidade
  • update_feature - Atualizar uma funcionalidade existente
  • get_feature - Obter detalhes da funcionalidade por ID
  • list_features - Listar funcionalidades com filtros opcionais
  • delete_feature - Excluir uma funcionalidade

Rastreamento de Bugs

  • create_bug - Criar um novo relatório de bug
  • update_bug - Atualizar um bug existente
  • get_bug - Obter detalhes do bug por ID
  • list_bugs - Listar bugs com filtros opcionais
  • delete_bug - Excluir um bug

Gerenciamento de Regras

  • create_rule - Criar uma nova regra de projeto
  • update_rule - Atualizar uma regra existente
  • get_rule - Obter detalhes da regra por ID
  • list_rules - Listar regras com filtros opcionais
  • delete_rule - Excluir uma regra

Pesquisa e Descoberta

  • search - Pesquisar em todos os itens do plano
  • advanced_search - Pesquisa avançada com filtros

Gerenciamento de Dados

  • backup_database - Criar um backup do banco de dados
  • restore_database - Restaurar a partir do backup
  • sync_filesystem - Sincronizar banco de dados para o sistema de arquivos

Recursos MCP

  • plan://index - Visão geral do plano do projeto (Markdown)
  • plan://tasks - Todas as tarefas (JSON)
  • plan://features - Todas as funcionalidades (JSON)
  • plan://bugs - Todos os bugs (JSON)
  • plan://rules - Todas as regras (JSON)
  • plan://stats - Estatísticas do projeto (JSON)

Configuração

Claude Desktop

Adicione à sua configuração do Claude Desktop:

{
  "mcpServers": {
    "follow-plan": {
      "command": "node",
      "args": [
        "/path/to/follow-plan-mcp/dist/index.js",
        "/path/to/your/project"
      ],
      "env": {}
    }
  }
}

Variáveis de Ambiente

  • LOG_LEVEL - Definir nível de registro (debug, info, warn, error)
  • PLAN_AUTO_SYNC - Ativar/desativar sincronização automática (padrão: true)
  • PLAN_BACKUP_INTERVAL - Intervalo de backup em segundos (padrão: 1800)

Desenvolvimento

Compilar

npm run build

Testar

npm test
npm run test:coverage

Lint

npm run lint
npm run lint:fix

Formatar

npm run format

Esquema do Banco de Dados

O servidor usa SQLite com pesquisa em texto completo FTS5. Tabelas principais:

  • tasks - Tarefas do projeto
  • features - Especificações de funcionalidades
  • bugs - Relatórios de bugs
  • rules - Regras do projeto
  • messages - Registros de comunicação
  • prompts - Modelos de prompt de IA
  • cascades - Fluxos de trabalho de automação
  • fts_search - Índice de pesquisa em texto completo

Arquitetura

src/
├── index.ts              # Main MCP server
├── types/                # TypeScript type definitions
├── services/             # Business logic services
│   ├── database-service.ts
│   ├── task-service.ts
│   ├── feature-service.ts
│   ├── bug-service.ts
│   ├── rule-service.ts
│   ├── search-service.ts
│   └── persistence-service.ts
├── handlers/             # MCP request handlers
│   ├── tools.ts
│   ├── resources.ts
│   ├── validation.ts
│   └── search-handlers.ts
├── utils/                # Utility functions
└── constants/            # Application constants

Contribuindo

  1. Faça um fork do repositório
  2. Crie um branch de funcionalidade
  3. Faça suas alterações
  4. Adicione testes
  5. Execute a suíte de testes
  6. Envie um pull request

Licença

Licença MIT - consulte o arquivo LICENSE para detalhes

Suporte

Para problemas e perguntas:

  • GitHub Issues: [Reporte um bug ou solicite uma funcionalidade]
  • Documentação: Consulte o diretório /docs
  • Exemplos: Consulte o diretório /examples

Follow Plan MCP - Planejamento inteligente de projetos para a era da IA 🚀