Angreal

Um servidor MCP que fornece capacidades de descoberta para assistentes de IA em projetos angreal.

Documentação

Servidor MCP Angreal

Um servidor MCP (Model Context Protocol) que fornece capacidades de descoberta para assistentes de IA em projetos angreal.

Visão Geral

Este servidor expõe a estrutura da árvore de comandos do angreal para clientes compatíveis com MCP, permitindo que assistentes de IA:

  • Descubram comandos e tarefas disponíveis no seu projeto angreal
  • Entendam a estrutura e as capacidades do projeto
  • Sugiram comandos apropriados com base no contexto

Pré-requisitos

  • angreal deve estar instalado e disponível no seu PATH
  • Toolchain Rust (para compilar a partir do código-fonte)

Instalação

# Install from crates.io
cargo install angreal_mcp

# Or install from git (latest development version)
cargo install --git https://github.com/colliery-io/angreal-mcp

Uso

Com Claude Code

Crie ou atualize seu arquivo de configuração MCP do Claude Code em ~/.config/claude-code/mcp_servers.json:

{
  "mcpServers": {
    "angreal": {
      "command": "angreal_mcp",
      "args": [],
      "env": {}
    }
  }
}

Com Claude Desktop

Adicione à sua configuração do Claude Desktop:

{
  "mcpServers": {
    "angreal": {
      "command": "angreal_mcp",
      "args": [],
      "cwd": "/path/to/your/angreal/project"
    }
  }
}

Com Cline (VS Code)

Adicione à sua configuração do Cline:

{
  "mcp": {
    "servers": [
      {
        "name": "angreal",
        "command": ["angreal_mcp"],
        "cwd": "${workspaceFolder}"
      }
    ]
  }
}

Teste via Linha de Comando

Você pode testar o servidor MCP diretamente via linha de comando:

# List available tools
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}' | angreal_mcp

# Get angreal command tree
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": {"name": "angreal_tree", "arguments": {"format": "json"}}}' | angreal_mcp

Ferramentas Disponíveis

angreal_check

Verifica se o diretório atual é um projeto angreal e obtém o status do projeto, incluindo comandos disponíveis.

angreal_tree

Obtém uma visão estruturada de todos os comandos e tarefas angreal disponíveis no projeto.

Parâmetros:

  • format (opcional): Formato de saída - "json" (padrão) ou "human"

angreal_run

Executa um comando ou tarefa angreal com argumentos opcionais.

Parâmetros:

  • command (obrigatório): O comando/tarefa angreal a ser executado
  • args (opcional): Argumentos e sinalizadores adicionais

Guia de Uso para Agentes

Ao trabalhar em projetos angreal, use estas ferramentas para descoberta e execução inteligente de comandos:

Fluxo de Uso das Ferramentas

  1. Comece pela descoberta: Use angreal_check para verificar o status e as capacidades do projeto
  2. Explore comandos: Use angreal_tree para ver comandos disponíveis com metadados ricos
  3. Execute com inteligência: Use angreal_run com seleção de parâmetros sensível ao contexto

Melhores Práticas

  • Sempre verifique as orientações de when_to_use e when_not_to_use de angreal_tree
  • Use recomendações de parâmetros (recommended_when) para melhores resultados
  • Verifique os pré-requisitos antes de executar comandos
  • Deixe a saída do comando e os códigos de saída guiarem a validação de sucesso

Padrões Comuns

  • Fluxos de configuração: Execute comandos de configuração/instalação antes dos comandos de build/teste
  • Ciclos de desenvolvimento: Use comandos de teste após alterações de código, comandos de build antes da implantação
  • Seleção de parâmetros: Use sinalizadores verbosos ao depurar, sinalizadores de produção para lançamentos

Solução de Problemas

  • Se o servidor MCP ficar indisponível, reinicie o Claude Code para reinicializar
  • Verifique se o binário angreal está instalado e acessível no PATH
  • Verifique se você está em um diretório de projeto angreal (contém a pasta .angreal/)

O servidor MCP angreal fornece metadados aprimorados de comandos, incluindo contexto de uso, orientação de parâmetros e categorização inteligente para permitir melhores decisões de automação.

Desenvolvimento

Executando Testes

Este projeto usa angreal como executor de testes:

# Run tests using angreal
angreal test

Estrutura do Projeto

angreal_mcp/
├── src/
│   ├── main.rs      # Main server loop
│   ├── mcp.rs       # MCP protocol implementation
│   └── angreal.rs   # Angreal integration
├── examples/        # Configuration examples
└── tests/          # Integration tests

Compilação

# Debug build
cargo build

# Release build
cargo build --release

Licença

Este projeto é licenciado duplamente sob MIT OU Apache-2.0.