MCP tools¶
The tools of odoo-work-cli mcp (how to connect a client).
Each tool runs the CLI command in the second column with --json and
returns its JSON unchanged: the fields are those of
JSON output, a failure is a result with isError: true
and the error envelope. An argument is named like the flag,
with _ for -.
The annotations tell the client what a tool does: readOnlyHint (changes
nothing), destructiveHint (may overwrite or remove data) and
idempotentHint (calling it again with the same arguments changes nothing
more). odoo-work-cli mcp --read-only serves only the read-only tools.
| Tool | Command | readOnlyHint | destructiveHint | idempotentHint |
|---|---|---|---|---|
whoami |
whoami |
yes | no | yes |
projects |
projects |
yes | no | yes |
tasks |
tasks |
yes | no | yes |
entries |
entries |
yes | no | yes |
timesheets |
timesheets |
yes | no | yes |
clock_status |
clock status |
yes | no | yes |
clock_list |
clock list |
yes | no | yes |
entries_add |
entries add |
no | no | no |
entries_update |
entries update |
no | yes | yes |
entries_delete |
entries delete |
no | yes | yes |
clock_in |
clock in |
no | no | no |
clock_out |
clock out |
no | no | no |
clock_add |
clock add |
no | no | no |
clock_edit |
clock edit |
no | yes | yes |
Results over 32 KiB come in pages. The list tools take a cursor
argument: the second content item of a paged result says which page it is
and gives next.cursor; pass it unchanged, with the same other arguments,
for the next page.
whoami¶
Current Odoo user
The Odoo user the server acts as: id, name, login, email, company. Same JSON as odoo-work-cli whoami --json.
No arguments.
projects¶
List projects
Projects (with the configured filters), with id, name, customer, company, stage. Use search to find the project ID to book on. Same JSON as odoo-work-cli projects --json. A result over 32 KiB comes in pages: page and next are in the second content block; pass next.cursor as cursor, with the same other arguments, for the next page.
| Argument | Type | Required | Description |
|---|---|---|---|
cursor |
string | no | next.cursor from the second content block of the previous page of the same call; omit for the first page |
search |
string | no | only projects whose name or customer contains this text (case-insensitive) |
tasks¶
List tasks
Tasks with id, name, project_id, project, stage; of one project with project_id. Same JSON as odoo-work-cli tasks --json. A result over 32 KiB comes in pages: page and next are in the second content block; pass next.cursor as cursor, with the same other arguments, for the next page.
| Argument | Type | Required | Description |
|---|---|---|---|
cursor |
string | no | next.cursor from the second content block of the previous page of the same call; omit for the first page |
project_id |
integer | no | only tasks of this project |
search |
string | no | only tasks whose name contains this text (case-insensitive) |
entries¶
List timesheet entries
The user's timesheet entries of one week (default: the current one) or one date, with id, date, project, task, description, hours, status. Same JSON as odoo-work-cli entries --json. A result over 32 KiB comes in pages: page and next are in the second content block; pass next.cursor as cursor, with the same other arguments, for the next page.
| Argument | Type | Required | Description |
|---|---|---|---|
cursor |
string | no | next.cursor from the second content block of the previous page of the same call; omit for the first page |
week |
string | no | ISO week, e.g. 2026-W10 (default: the current week) |
date |
string | no | one day, YYYY-MM-DD (overrides week) |
project |
string | no | only entries whose project name contains this text (case-insensitive) |
task |
string | no | only entries whose task name contains this text (case-insensitive) |
status |
string | no | only entries with this validation status, e.g. draft or validated |
timesheets¶
Weekly timesheet
All timesheet entries of one ISO week (default: the current one). Same JSON as odoo-work-cli timesheets --json. A result over 32 KiB comes in pages: page and next are in the second content block; pass next.cursor as cursor, with the same other arguments, for the next page.
| Argument | Type | Required | Description |
|---|---|---|---|
cursor |
string | no | next.cursor from the second content block of the previous page of the same call; omit for the first page |
week |
string | no | ISO week, e.g. 2026-W10 (default: the current week) |
clock_status¶
Attendance status
Whether the user is clocked in, since when, and today's attendance periods and total. Same JSON as odoo-work-cli clock status --json.
No arguments.
clock_list¶
List attendance records
Attendance records of one day (default today) or one ISO week, with id, check_in, check_out, running, worked_hours. Same JSON as odoo-work-cli clock list --json. A result over 32 KiB comes in pages: page and next are in the second content block; pass next.cursor as cursor, with the same other arguments, for the next page.
| Argument | Type | Required | Description |
|---|---|---|---|
cursor |
string | no | next.cursor from the second content block of the previous page of the same call; omit for the first page |
date |
string | no | the day, YYYY-MM-DD (default today); not together with week |
week |
string | no | an ISO week, e.g. 2026-W10; not together with date |
entries_add¶
Book a timesheet entry
Create a timesheet entry and return it. With dry_run=true nothing is written: the entry that would be created comes back with dry_run true and the duplicates (same day, project, task and description). Propose with dry_run first. Same JSON as odoo-work-cli entries add --json.
| Argument | Type | Required | Description |
|---|---|---|---|
project_id |
integer | yes | project ID (from projects) |
task_id |
integer | no | task ID of that project (from tasks) |
date |
string | no | YYYY-MM-DD (default today) |
hours |
number or string | yes | hours worked: a number (2.5) or H:MM ("2:30") |
description |
string | yes | what was done |
dry_run |
boolean | no | resolve and validate, print the entry that would be written and its duplicates, write nothing |
entries_update¶
Change a timesheet entry
Overwrite the given fields of a timesheet entry and return it; fields not given stay. With dry_run=true nothing is written: the merged entry comes back with dry_run true. Same JSON as odoo-work-cli entries update --json.
| Argument | Type | Required | Description |
|---|---|---|---|
id |
integer | yes | entry ID (from entries) |
project_id |
integer | no | new project ID |
task_id |
integer | no | new task ID |
date |
string | no | new date, YYYY-MM-DD |
hours |
number or string | no | hours worked: a number (2.5) or H:MM ("2:30") |
description |
string | no | new description |
dry_run |
boolean | no | resolve and validate, print the entry that would be written and its duplicates, write nothing |
entries_delete¶
Delete a timesheet entry
Delete a timesheet entry and return it as it was. Same JSON as odoo-work-cli entries delete --json.
| Argument | Type | Required | Description |
|---|---|---|---|
id |
integer | yes | entry ID (from entries) |
clock_in¶
Clock in
Start attendance now (or at a past time) and return the running record. conflict when already clocked in. Same JSON as odoo-work-cli clock in --json.
| Argument | Type | Required | Description |
|---|---|---|---|
at |
string | no | a past time (HH:MM or YYYY-MM-DD HH:MM) instead of now; needs attendance officer rights |
clock_out¶
Clock out
End the running attendance now (or at a past time) and return the record. conflict when not clocked in. Same JSON as odoo-work-cli clock out --json.
| Argument | Type | Required | Description |
|---|---|---|---|
at |
string | no | a past time (HH:MM or YYYY-MM-DD HH:MM) instead of now; needs attendance officer rights |
clock_add¶
Add an attendance record
Create one attendance record with check-in and check-out, for several records a day (e.g. around a break). conflict, and nothing written, when it overlaps a record. Same JSON as odoo-work-cli clock add --json.
| Argument | Type | Required | Description |
|---|---|---|---|
date |
string | no | the day, YYYY-MM-DD (default today) |
in |
string | yes | check-in, HH:MM or YYYY-MM-DD HH:MM |
out |
string | yes | check-out, HH:MM or YYYY-MM-DD HH:MM (a later day for overnight) |
clock_edit¶
Set a day's attendance
Set check-in and/or check-out of the day's attendance record, or create it when the day has none; returns before and after. Overwrites an existing record unless create_only. Same JSON as odoo-work-cli clock edit --json.
| Argument | Type | Required | Description |
|---|---|---|---|
date |
string | no | the day, YYYY-MM-DD (default today) |
in |
string | no | new check-in, HH:MM or YYYY-MM-DD HH:MM |
out |
string | no | new check-out, HH:MM or YYYY-MM-DD HH:MM |
id |
integer | no | the record to edit when the day has several (from clock_list) |
create_only |
boolean | no | only create; conflict, and nothing changed, when the day already has a record |