vikunjamcp/USAGE.md

46 lines
940 B
Markdown
Raw Normal View History

2025-10-07 00:10:22 +00:00
# Usage
This document provides instructions on how to add and use the Vikunja MCP server with the Gemini CLI.
## Prerequisites
Before adding the MCP server, you need to set the following environment variables:
```bash
export VIKUNJA_URL="<your_vikunja_url>"
export VIKUNJA_USERNAME="<your_vikunja_username>"
export VIKUNJA_PASSWORD="<your_vikunja_password>"
```
## Adding the MCP Server
To add the Vikunja MCP server to the Gemini CLI, use the following command:
```bash
gemini mcp add --name vikunja --command "python main.py"
```
## Starting the MCP Server
To start the Vikunja MCP server, use the following command:
```bash
gemini mcp start vikunja
```
## Stopping the MCP Server
To stop the Vikunja MCP server, use the following command:
```bash
gemini mcp stop vikunja
```
## Removing the MCP Server
To remove the Vikunja MCP server from the Gemini CLI, use the following command:
```bash
gemini mcp remove vikunja
```