mcp-rappel-conso

kseghair/mcp-rappel-conso

3.2

If you are the rightful owner of mcp-rappel-conso and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The MCP Server Project is a NestJS application designed to interact with the open data platform data.gouv.fr, specifically to retrieve data from RappelConso. The application is containerized with Docker and made publicly accessible via Ngrok.

MCP Server Project with data.gouv.fr Data

This project is a NestJS application designed to interact with the open data platform data.gouv.fr, specifically to retrieve data from RappelConso. The entire application is containerized with Docker and made publicly accessible via Ngrok.

✨ Features

  • MCP Server Exposure: The configuration is ready to expose an MCP server through a secure application tunnel.
  • data.gouv.fr Integration: Provides tools to retrieve and use data from RappelConso.
  • NestJS Framework: The application is built on a modern, scalable, and high-performance Node.js framework.
  • Dockerized Environment: The entire setup is containerized with Docker and orchestrated by Docker Compose for maximum portability.
  • Ngrok Integration: An ngrok service is included to instantly and securely expose the local API to the internet.
  • Multi-Stage Docker Build: The Dockerfile is optimized for production, creating a lightweight final image.
  • Secrets Management: Uses a .env file to securely manage API keys (like the Ngrok authtoken).

🚀 Getting Started

Prerequisites

Installation Steps

  1. Clone the repository:

    git clone https://github.com/kseghair/mcp-rappel-conso.git
cd mcp-rappel-conso

  2. Configure Ngrok: Create a .env file in the project root and add your Ngrok authentication token:

    NGROK_AUTHTOKEN=YOUR_TOKEN_HERE

  3. Launch the services: Use Docker Compose to build the images and start the containers in the background.

    docker-compose up --build -d

  4. Access your application:

    • Your API is accessible locally at http://localhost:3000.
    • The Ngrok web interface is at http://localhost:4040.
    • Your public URL is visible in the Ngrok interface.

Stopping the services

To stop all containers, run:

docker-compose down

🛠️ Tech Stack

📋 Useful Commands

  • Install dependencies (outside of Docker): 
    npm install
  • Run the application locally: 
    npm run start:dev
  • Lint and fix errors: 
    npm run lint
  • Format the code: 
    npm run format
  • Run unit tests: 
    npm run test
  • Run End-to-End (E2E) tests: 
    npm run test:e2e
  • Create a production build: 
    npm run build