Skip to main content
Glama
LucasVelho

mcpRedmine

by LucasVelho
README.md
# MCP Redmine

Servidor MCP em TypeScript para consultar o Redmine. A primeira tool disponível é `list_projects`.

## Pré-requisitos e instalação

Requer Node.js 20 ou superior.

```bash
npm install
cp .env.example .env
```

Preencha `.env` sem incluir credenciais no repositório:

```env
REDMINE_URL=https://redmine.exemplo.com
REDMINE_API_KEY=sua-chave
```

## Uso

Para iniciar com dados simulados, sem configurar variáveis de ambiente ou acessar o Redmine:

```bash
npm run start-dev
```

Esse modo também usa `stdio`, exibe quatro projetos estáveis de exemplo e não envia nenhuma requisição HTTP. Ele é destinado apenas ao desenvolvimento local.

Para conectar à API real do Redmine, preencha `.env` e execute:

```bash
npm run build
npm start
```

O servidor usa transporte `stdio`; configure o cliente MCP para executar `node /caminho/para/mcpRedmine/dist/server.js`, com `REDMINE_URL` e `REDMINE_API_KEY` no ambiente do processo.

Execute validações com:

```bash
npm run check
npm test
```

## Tool `list_projects`

Entrada: `{}`.

Exemplo de resposta:

```json
{
  "projects": [{
    "id": 12,
    "name": "Aplicativo Mobile",
    "identifier": "aplicativo-mobile",
    "description": "Projeto responsável pelo aplicativo mobile.",
    "status": "active",
    "parent": { "id": 3, "name": "Produtos Digitais" }
  }],
  "totalCount": 1
}
```

O servidor busca todas as páginas internamente e não expõe detalhes de paginação, credenciais ou campos internos do Redmine.