Document available MCP tools in README

Amolith and Crush created 1 month ago

Added a comprehensive list of all available tools with their parameters
and descriptions to the README.md file.

- Documented get_timestamp tool
- Documented list_areas_and_goals tool
- Documented create_task tool with all parameters
- Documented update_task tool with all parameters
- Documented delete_task tool
- Documented list_habits_and_activities tool
- Documented track_habit_activity tool

This makes it easier for users to understand what tools are available
and how to use them.

Co-Authored-By: Crush <[e-mail]>

Change summary

README.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 73 insertions(+)

Detailed changes

README.md

@@ -46,6 +46,79 @@ Point [Home Assistant's MCP integration] at the `/sse` endpoint.
 
 [Home Assistant's MCP integration]: https://www.home-assistant.io/integrations/mcp/
 
+## Available Tools
+
+This MCP server provides several tools for interacting with Lunatask:
+
+### `get_timestamp`
+
+Parses natural language dates into RFC3339 timestamps.
+
+**Parameters:**
+- `natural_language_date` (string, required): A natural language description of a date/time (e.g., "today at 3pm", "next Monday", "in 2 hours")
+
+### `list_areas_and_goals`
+
+Lists all configured areas and their goals in Lunatask.
+
+**Returns:**
+- Text formatted as a list with area names and IDs, and their associated goal names and IDs
+
+### `create_task`
+
+Creates a new task in Lunatask.
+
+**Parameters:**
+- `area_id` (string, required): UUID of the area to create the task in
+- `name` (string, required): Name of the task (max 100 characters)
+- `goal_id` (string, optional): UUID of the goal to associate the task with
+- `note` (string, optional): Additional notes for the task in Markdown format
+- `status` (string, optional): Task status - one of "later", "next", "started", "waiting", or "completed"
+- `motivation` (string, optional): Motivation level - one of "must", "should", or "want"
+- `estimate` (integer, optional): Estimated time to complete task in minutes (0-720)
+- `priority` (string, optional): Task priority - one of "lowest", "low", "neutral", "high", or "highest"
+- `eisenhower` (string, optional): Eisenhower matrix categorization - one of "uncategorised", "both urgent and important", "urgent, but not important", "important, but not urgent", or "neither urgent nor important"
+- `scheduled_on` (string, optional): RFC3339 formatted timestamp for when the task is scheduled
+
+### `update_task`
+
+Updates an existing task in Lunatask.
+
+**Parameters:**
+- `task_id` (string, required): UUID of the task to update
+- `area_id` (string, optional): UUID of the area to move the task to
+- `name` (string, optional): New name for the task
+- `goal_id` (string, optional): UUID of the goal to associate the task with
+- `note` (string, optional): Additional notes for the task in Markdown format
+- `status` (string, optional): Task status - one of "later", "next", "started", "waiting", or "completed"
+- `motivation` (string, optional): Motivation level - one of "must", "should", or "want"
+- `estimate` (integer, optional): Estimated time to complete task in minutes (0-720)
+- `priority` (string, optional): Task priority - one of "lowest", "low", "neutral", "high", or "highest"
+- `eisenhower` (string, optional): Eisenhower matrix categorization - one of "uncategorised", "both urgent and important", "urgent, but not important", "important, but not urgent", or "neither urgent nor important"
+- `scheduled_on` (string, optional): RFC3339 formatted timestamp for when the task is scheduled
+
+### `delete_task`
+
+Deletes a task from Lunatask.
+
+**Parameters:**
+- `task_id` (string, required): UUID of the task to delete
+
+### `list_habits_and_activities`
+
+Lists all configured habits in Lunatask.
+
+**Returns:**
+- Text formatted as a list with habit names and IDs
+
+### `track_habit_activity`
+
+Tracks an activity for a habit in Lunatask.
+
+**Parameters:**
+- `habit_id` (string, required): UUID of the habit to track
+- `performed_on` (string, required): RFC3339 formatted timestamp of when the habit was performed
+
 ## Collaboration
 
 Patch requests are in [amolith/lunatask-mcp-server] on [pr.pico.sh]. You don't