Nemex81/spark-framework-engine

O que spark-framework-engine faz?

SPARK Code Framework — MCP Engine: servidor de framework universal nativo para IA no modo Agente do VS Code. Fornece agentes, habilidades, instruções e prompts sob demanda para qualquer projeto.

Visão Geral

O SPARK Code Framework MCP Engine é um servidor leve que implementa o protocolo MCP (Model Context Protocol). Ele permite que agentes de IA, como o Claude Code, Cursor ou Codex, consultem dinamicamente habilidades, instruções e prompts específicos do projeto, eliminando a necessidade de pré-carregar todo o conhecimento do framework.

Como Funciona

1. Inicialização: O SPARK é executado como um servidor MCP no VS Code Agent mode.
2. Registro de Habilidades: Habilidades, instruções e prompts são registrados em um repositório central ou em arquivos locais.
3. Consulta: O agente de IA faz consultas ao servidor SPARK para obter as habilidades e instruções relevantes para a tarefa atual.
4. Execução: O agente recebe o conhecimento necessário e executa a tarefa com base nas instruções fornecidas.

Instalação

npm install -g spark-framework-engine

Ou adicione como dependência do projeto:

npm install spark-framework-engine --save-dev

Configuração

Crie um arquivo .sparkrc.json na raiz do seu projeto:

{
  "mcp": {
    "server": "spark-framework-engine",
    "args": ["--port", "8080"]
  },
  "skills": [
    {
      "name": "my-awesome-skill",
      "path": "./skills/my-awesome-skill.md"
    }
  ]
}

Uso no VS Code Agent Mode

No VS Code Agent mode, configure o arquivo .vscode/launch.json ou as configurações do agente para usar o SPARK como servidor MCP:

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "mcp",
      "name": "SPARK Framework Engine",
      "request": "launch",
      "server": "spark-framework-engine"
    }
  ]
}

Habilidades (Skills)

As habilidades são arquivos Markdown que definem instruções específicas para o agente de IA. Elas podem ser colocadas em um diretório skills/ no seu projeto.

Exemplo de habilidade (skills/code-review.md):

# Code Review Skill

Ao revisar código, siga estas diretrizes:

1. Verifique a legibilidade do código.
2. Verifique se há testes adequados.
3. Verifique a aderência aos padrões do projeto.
4. Sugira melhorias de desempenho se aplicável.

Instruções (Instructions)

Instruções são comandos ou diretivas que o agente deve seguir ao executar tarefas. Elas podem ser definidas no arquivo de configuração ou em arquivos Markdown separados.

Prompts

Prompts são modelos de entrada para o agente, permitindo iniciar tarefas com um contexto pré-definido.

Contribuição

Contribuições são bem-vindas! Envie pull requests ou abra issues no repositório GitHub.

Licença

MIT