Vikunja MCP server

The MCP server for Vikunja reminders provides a simple way to create and manage reminders using the Model Context Protocol. This lightweight server connects to your Vikunja instance and lets you add reminders via a compatible MCP client.

Installation

You can install the MCP server for Vikunja reminders through Docker or manually from source.

Docker Installation

The easiest way to run the server is using Docker:

docker run -p 3000:3000 --env-file .env ghcr.io/mcp-pm/mcp-vikunja-reminders:latest

Manual Installation

To install manually:

1. Clone the repository:

   git clone https://github.com/mcp-pm/mcp-vikunja-reminders.git
   cd mcp-vikunja-reminders
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

4. Start the server:

   npm start
   

Configuration

Create a .env file in the root directory with the following variables:

VIKUNJA_URL=https://your-vikunja-instance.com/api/v1
VIKUNJA_USERNAME=your_username
VIKUNJA_PASSWORD=your_password
DEFAULT_LIST_ID=1  # ID of the list where reminders will be added
PORT=3000  # Optional, defaults to 3000

Environment Variables

• VIKUNJA_URL: The URL of your Vikunja API endpoint
• VIKUNJA_USERNAME: Your Vikunja username
• VIKUNJA_PASSWORD: Your Vikunja password
• DEFAULT_LIST_ID: The ID of the default list for adding tasks
• PORT: The port on which the MCP server will run (optional)

Usage

Once the server is running, you can interact with it using any MCP-compatible client.

Adding Reminders

To add a reminder, send a request to the server with your reminder text and optional time. The server will handle formatting and adding the reminder to your configured Vikunja list.

Endpoint

The server exposes an MCP-compatible endpoint at:

http://localhost:3000/api/mcp

Client Configuration

If you're using an MCP client, add this server with the following configuration:

• Name: Vikunja Reminders
• URL: http://localhost:3000/api/mcp
• Type: MCP

Troubleshooting

If you encounter issues:

• Check your .env file is properly configured
• Verify your Vikunja credentials and URL are correct
• Ensure the DEFAULT_LIST_ID exists in your Vikunja instance
• Check server logs for detailed error messages

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.