Lago/MCP-CalDAV
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update default MCP_MODE to STDIO and add all_day and recurrence parameters to event creation/update methods.

Browse Source
This commit is contained in:
Lago
2026-01-26 16:30:55 +01:00
parent df920c94b7
commit 911d3d6560
1 changed files with 11 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -64,22 +64,21 @@ uv run uvicorn src.server:mcp.sse_app --host 0.0.0.0 --port 8000
You can run the server using Docker and Docker Compose. Environment variables are loaded from the `.env` file.
**Build and Run (SSE Mode by default):**
**Build and Run (STDIO Mode by default):**
```bash
docker compose up --build
```
**Switching Modes:**
The container supports two modes via the `MCP_MODE` environment variable:
- `SSE` (default): Runs the HTTP server on port 8000.
- `STDIO`: Runs the script via standard I/O.
- `STDIO` (default): Runs the script via standard I/O.
- `SSE`: Runs the HTTP server on port 8000.
To run in STDIO mode (e.g., for piping):
To run in SSE mode (e.g., for HTTP access):
```bash
docker compose run -e MCP_MODE=STDIO -T caldev_mcp
docker run -e MCP_MODE=SSE -p 8000:8000 --env-file .env mcp-caldav
```
### Configuring an MCP Client
To use this with an MCP client (like Claude Desktop or another MCP-compatible app), add the following configuration to your client's settings (e.g., `claude_desktop_config.json`):
@@ -115,11 +114,14 @@ To use this with an MCP client (like Claude Desktop or another MCP-compatible ap
- `start_date` (optional): Start of the range (YYYY-MM-DD or ISO).
- `end_date` (optional): End of the range.
- **`create_event(calendar_name, summary, start_time, end_time, description="")`**
- **`create_event(calendar_name, summary, start_time, end_time, description="", all_day=False, recurrence=None)`**
- Creates an event.
- `all_day` (optional, bool): Set to `True` for all-day events (start/end times treated as dates).
- `recurrence` (optional, str): RRULE string (e.g., `FREQ=DAILY;COUNT=10` or `FREQ=WEEKLY;BYDAY=MO,WE`).
- **`update_event(calendar_name, event_uid, summary=None, start_time=None, end_time=None, description=None)`**
- **`update_event(calendar_name, event_uid, summary=None, start_time=None, end_time=None, description=None, all_day=None, recurrence=None)`**
- Updates an event by UID.
- `all_day` (optional, bool): Set to `True`/`False` to change event type.
- `recurrence` (optional, str): Update the recurrence rule.
- **`delete_event(calendar_name, event_uid)`**
- Deletes an event by UID.