Quire MCP Server

Interaja com projetos e tarefas do Quire.io usando a API do Quire, permitindo que assistentes de IA gerenciem seu fluxo de trabalho.

Documentação

⚠️ Aviso: Projeto de Codificação "Vibe" ⚠️

Este é um projeto de codificação baseado em "vibe". Embora funcional, ele é desenvolvido com foco em implementação rápida e experimentação. Use por sua conta e risco. O autor não é responsável por quaisquer consequências, perda de dados ou comportamento inesperado que possa surgir do seu uso.


Quire MCP Server

Este projeto fornece um servidor Model Context Protocol (MCP) para Quire. Ele expõe ferramentas que permitem que assistentes de IA interajam com seus projetos e tarefas diretamente pela interface de chat da sua IA.

Este servidor usa OAuth2 para autenticação e foi projetado para ser executado facilmente via npx.

1. Obtendo Suas Credenciais do Quire

Este servidor usa um token de atualização OAuth2 para autenticação. Você só precisa realizar este processo de configuração uma vez.

Passo 1: Criar um Aplicativo Quire

  1. Acesse a página de Aplicativos Quire.
  2. Clique em Criar um novo aplicativo.
  3. Preencha os detalhes:
    • Nome: Dê um nome ao seu aplicativo (ex.: "Meu-Cliente-MCP").
    • Site: Você pode usar um espaço reservado, como https://localhost.
    • URI de Redirecionamento: Defina como https://localhost. Isso é crucial para o próximo passo.
  4. Após criar o aplicativo, anote o Client ID e o Client Secret.

Passo 2: Obter um Código de Autorização

  1. Construa a seguinte URL no seu navegador, substituindo YOUR_CLIENT_ID pelo ID que você obteve no passo anterior.
    https://quire.io/oauth?client_id=YOUR_CLIENT_ID&redirect_uri=https://localhost
    
  2. Visite a URL. Será solicitado que você faça login no Quire e autorize o aplicativo.
  3. Após autorizar, seu navegador será redirecionado para uma página em branco com uma URL como: https://localhost/?code=SOME_LONG_CODE
  4. Copie o valor de code da URL. Este código é temporário e será usado no próximo passo.

Passo 3: Trocar o Código por um Token de Atualização

  1. Abra seu terminal e use curl para fazer uma solicitação POST ao endpoint de token do Quire.

  2. Substitua os espaços reservados pelas suas credenciais reais.

    curl -X POST https://quire.io/oauth/token \
      -d grant_type=authorization_code \
      -d code=PASTE_THE_CODE_FROM_STEP_2_HERE \
      -d client_id=YOUR_CLIENT_ID \
      -d client_secret=YOUR_CLIENT_SECRET
    
  3. A resposta será um objeto JSON contendo seu access_token e refresh_token.

  4. Salve o valor de refresh_token. Este é o token que você usará para executar o servidor. Ele tem longa duração e será usado para buscar automaticamente novos tokens de acesso.

2. Início Rápido e Uso

Definir Variáveis de Ambiente

Defina as seguintes três variáveis de ambiente no seu terminal.

# Replace with the credentials you obtained above
export QUIRE_CLIENT_ID="your_client_id"
export QUIRE_CLIENT_SECRET="your_client_secret"
export QUIRE_REFRESH_TOKEN="your_refresh_token"

Executar com npx

Depois que as variáveis de ambiente estiverem definidas, você pode executar o servidor com um único comando:

npx quire-mcp

3. Guia de Configuração do Cursor

  1. Encontre seu arquivo mcp.json: ~/.cursor-settings/mcp.json

  2. Adicione a configuração do servidor:

    {
      "mcpServers": {
        "quire": {
          "command": "npx",
          "args": [
            "-y",
            "quire-mcp"
          ],
          "env": {
            "QUIRE_CLIENT_ID": "${env:QUIRE_CLIENT_ID}",
            "QUIRE_CLIENT_SECRET": "${env:QUIRE_CLIENT_SECRET}",
            "QUIRE_REFRESH_TOKEN": "${env:QUIRE_REFRESH_TOKEN}"
          }
        }
      }
    }
    
  3. Garanta que as Variáveis de Ambiente Estejam Definidas: Antes de iniciar o Cursor, certifique-se de que as variáveis estejam definidas no ambiente do seu shell (.zshrc, .bash_profile, etc.).

  4. Reinicie o Cursor para carregar o novo servidor MCP.

4. Para Desenvolvedores

Executando a Partir do Código-Fonte

  1. Clone e instale as dependências:
    git clone <repository_url>
    cd quire-mcp && npm install
    
  2. Crie um arquivo .env:
    QUIRE_CLIENT_ID=your_client_id
    QUIRE_CLIENT_SECRET=your_client_secret
    QUIRE_REFRESH_TOKEN=your_refresh_token
    
  3. Execute o servidor:
    npm run build
    npm start
    

Executando Testes

npm test

Recursos

  • Listar projetos
  • Listar tarefas dentro de um projeto
  • (Mais recursos serão adicionados)