listify/listify-api/README.md

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Project setup

$ npm install

Compile and run the project

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Mistral assistant

The in-app assistant calls Mistral from the API server. Configure the key in the API environment, never in the Angular client:

MISTRAL_API_KEY=your-mistral-api-key
MISTRAL_MODEL=mistral-small-latest

The authenticated frontend calls POST /api/assistant/chat; the API then calls Mistral and may execute allowed Listify actions such as creating lists or adding list items.

Run tests

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

MCP-Agent anbinden

Die API enthaelt einen Remote-MCP-Server unter /mcp. Er nutzt den bestehenden JWT-Login der REST-API. Ein Agent oder MCP-Client darf deshalb nur mit einem gueltigen Access Token eines verifizierten Users auf die Tools zugreifen.

Ablauf

1. User ueber die normale Auth-API anmelden, z. B. POST /auth/login.
2. accessToken aus der Login-Antwort speichern.
3. MCP-Client auf den Streamable-HTTP-Endpunkt konfigurieren:

http://localhost:3000/mcp

4. Bei jedem MCP-Request diesen Header senden:

Authorization: Bearer <accessToken>

Der Server erzeugt beim MCP-Initialize eine Session. Folge-Requests muessen den vom Server gelieferten mcp-session-id Header mitsenden. Die Session ist an den User aus dem JWT gebunden; ein Token eines anderen Users kann dieselbe MCP-Session nicht weiterverwenden.

Verfuegbare Tools

• list_existing_lists

  • Liest die Listen des angemeldeten Users.
  • Input: { "includeItems": true | false }
  • Schreibt keine Daten.

• list_templates

  • Liest die Listenvorlagen des angemeldeten Users.
  • Input: optional { "kind": "packing" | "shopping" | "todo" | "custom" }
  • Schreibt keine Daten.

• suggest_lists

  • Erzeugt strukturierte Vorschlaege fuer neue Listen.
  • Input:

{
  "goal": "Sommerurlaub mit Handgepaeck",
  "kind": "packing",
  "constraints": ["Nur Handgepaeck", "Reisedokumente nicht vergessen"]
}

• Output enthaelt suggestions mit name, description, kind, items, optionalem Template-Bezug und rationale.

• Schreibt keine Daten und legt keine Liste an.

• create_list

  • Erstellt eine neue Liste fuer den angemeldeten User.
  • Input:

{
  "name": "Sommerurlaub",
  "description": "Packliste fuer die Reise",
  "kind": "packing",
  "items": [
    { "title": "Pass", "required": true },
    { "title": "Tickets", "notes": "Digital und offline sichern" }
  ]
}

• items ist optional. Wenn Items angegeben sind, werden sie nach dem Erstellen der Liste in Reihenfolge hinzugefuegt.

• Output enthaelt list mit der erstellten Liste inklusive Items.

• add_list_item

  • Fuegt ein Item zu einer bestehenden Liste hinzu, auf die der angemeldete User Zugriff hat.
  • Input:

{
  "listId": "list-id",
  "title": "Milch",
  "quantity": 2,
  "required": true
}

• Output enthaelt list mit der aktualisierten Liste.

Minimaler MCP-Request

Ein MCP-Client uebernimmt normalerweise Initialize, Session-Header und Tool-Calls selbst. Fuer eigene Tests sieht ein Tool-Call nach erfolgreicher Initialisierung sinngemaess so aus:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "suggest_lists",
    "arguments": {
      "goal": "Sommerurlaub mit Handgepaeck",
      "kind": "packing",
      "constraints": ["Nur Handgepaeck"]
    }
  }
}

Wichtig: Der aktuelle Ausbau erlaubt Erstellen von Listen und Hinzufuegen von Items. Aendern, Abhaken, Loeschen und Teilen von Listen ist ueber MCP noch nicht freigegeben.

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g @nestjs/mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.