@kadoa/mcp 0.5.25 → 0.5.29

package/README.md

@@ -66,7 +66,7 @@ Point your client to `https://mcp.kadoa.com/mcp` with OAuth authentication.
 | `mark_inbox_item_read` | Acknowledge one Inbox item without performing its underlying workflow action |
 | `create_workflow` | Create an agentic navigation workflow from a prompt |
 | `create_realtime_monitor` | Create an asynchronous realtime monitoring workflow after persisting notification channels; returns workflow/session/thread/job IDs |
-| `list_workflows` | List all workflows with status |
+| `list_workflows` | List workflows with status, Assistant session availability, template version drift, and realtime freshness or health |
 | `get_workflow` | Get canonical intent, Assistant/session, template ownership, run health, schedule, location, monitoring, and validation details |
 | `request_workflow_update` | Ask the workflow Assistant to change extraction intent, navigation, sourcing, pagination, or generated behavior without changing the workflow ID |
 | `get_workflow_assistant` | Get the workflow Assistant's current activity and any pending clarification question |
@@ -88,6 +88,16 @@ Point your client to `https://mcp.kadoa.com/mcp` with OAuth authentication.
 | `team_list` | List all teams you belong to and see which is active |
 | `team_switch` | Switch the active team by name or ID |
 
+## Workflow controls and behavior
+
+For detailed customer guidance, see the [Kadoa documentation](https://docs.kadoa.com/docs/introduction), including [workflows](https://docs.kadoa.com/docs/workflows/overview), [Workflow Assistant](https://docs.kadoa.com/docs/sdk/workflows/assistant), [Personal Inbox](https://docs.kadoa.com/docs/sdk/inbox), [notifications](https://docs.kadoa.com/docs/notifications), and [templates](https://docs.kadoa.com/docs/templates).
+
+- **Assistant work vs. schedule:** `interrupt_workflow_assistant`, `resume_workflow_assistant`, and `stop_workflow_assistant` control the Assistant session only; they do not pause scheduled workflow runs. Use `pause_workflow` to stop an active workflow's schedule and `approve_workflow` to activate it again.
+- **Inbox acknowledgement:** `mark_inbox_item_read` only acknowledges an item. For an Assistant question, inspect it with `get_workflow_assistant`, then use `answer_workflow_assistant_question` to answer and resume; use `resume_workflow_assistant` only for an idle or interrupted Assistant.
+- **Run history:** `list_workflow_runs` filters by `status` (`success`, `failed`, or `in_progress`) and supports 1-based `page` and `limit` pagination.
+- **Notifications:** `create_realtime_monitor` requires at least one email, webhook, Slack, or WebSocket notification channel. Notifications are optional when creating a standard one-time or scheduled workflow with `create_workflow`.
+- **Template changes:** `update_template` changes template name and description only. To change template-controlled configuration, create an immutable version with `create_template_version`, then roll it out to linked workflows with `apply_template_version`.
+
 ## Usage Examples
 
 Once the MCP server is configured, you can manage the full workflow lifecycle through natural conversation. Here are a few common operations shown as Claude Code sessions.
@@ -154,8 +164,8 @@ workflow ID for follow-up with get_workflow or fetch_data.
 ```
 > You: List my workflows.
 
-Claude calls list_workflows and shows all workflows with their
-current status (complete, running, failed, paused, scheduled, etc.).
+Claude calls list_workflows and shows current status, Assistant session
+availability, template version drift, and realtime freshness or health.
 
 > You: Update wf_abc123 — add an "availability" field to the schema
         and rename "cost" to "price".