Teamwork

Teamwork

Tools for Teamwork.com products.

10K+

194 Tools

Packaged by
Requires Secrets
Add to Docker Desktop

Version 4.43 or later needs to be installed to add the server automatically

About

Teamwork MCP Server

Tools for Teamwork.com products.

What is an MCP Server?

MCP Info

AttributeDetails
Docker Imagemcp/teamwork
AuthorTeamwork
Repositoryhttps://github.com/teamwork/mcp

Image Building Info

AttributeDetails
Dockerfilehttps://github.com/teamwork/mcp/blob/9e26e66a0592c56065b22a9507c460f9c05be277/Dockerfile
Commit9e26e66a0592c56065b22a9507c460f9c05be277
Docker Image built byDocker Inc.
Docker Scout Health ScoreDocker Scout Health Score
Verify SignatureCOSIGN_REPOSITORY=mcp/signatures cosign verify mcp/teamwork --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub
LicenceMIT License

Available Tools (194)

Tools provided by this ServerShort Description
twchat-get_conversationGet Chat Conversation
twchat-get_current_userGet Current Chat User
twchat-get_or_create_dmGet or Create Direct Message
twchat-list_conversationsList Chat Conversations
twchat-list_messagesList Chat Messages
twchat-list_peopleList Chat People
twchat-send_dmSend Direct Message
twchat-send_messageSend Chat Message
twdesk-create_companyCreate Company
twdesk-create_customerCreate Customer
twdesk-create_fileCreate File
twdesk-create_helpdoc_articleCreate Help Doc Article
twdesk-create_priorityCreate Priority
twdesk-create_statusCreate Status
twdesk-create_tagCreate Tag
twdesk-create_ticketCreate Ticket
twdesk-create_ticket_typeCreate Ticket Type
twdesk-get_companyGet Company
twdesk-get_customerGet Customer
twdesk-get_helpdoc_articleGet Help Doc Article
twdesk-get_inboxGet Inbox
twdesk-get_priorityGet Priority
twdesk-get_statusGet Status
twdesk-get_tagGet Tag
twdesk-get_ticketGet Ticket
twdesk-get_ticket_typeGet Ticket Type
twdesk-get_userGet User
twdesk-list_companiesList Companies
twdesk-list_customersList Customers
twdesk-list_inboxesList Inboxes
twdesk-list_prioritiesList Priorities
twdesk-list_statusesList Statuses
twdesk-list_tagsList Tags
twdesk-list_ticket_typesList Ticket Types
twdesk-list_usersList Users
twdesk-reply_ticketReply to Ticket
twdesk-search_helpdoc_articlesSearch Help Doc Articles
twdesk-search_ticketsSearch Tickets
twdesk-update_companyUpdate Company
twdesk-update_customerUpdate Customer
twdesk-update_helpdoc_articleUpdate Help Doc Article
twdesk-update_priorityUpdate Priority
twdesk-update_statusUpdate Status
twdesk-update_tagUpdate Tag
twdesk-update_ticketUpdate Ticket
twdesk-update_ticket_typeUpdate Ticket Type
twprojects-add_project_memberAdd Project Member
twprojects-clone_projectClone Project
twprojects-complete_taskComplete Task
twprojects-complete_timerComplete Timer
twprojects-create_commentCreate Comment
twprojects-create_companyCreate Company
twprojects-create_custom_fieldCreate Custom Field
twprojects-create_custom_field_valueCreate Custom Field Value
twprojects-create_custom_itemCreate Custom Item
twprojects-create_custom_item_fieldCreate Custom Item Field
twprojects-create_custom_item_recordCreate Custom Item Record
twprojects-create_jobroleCreate Job Role
twprojects-create_linkCreate Link
twprojects-create_messageCreate Message
twprojects-create_message_replyCreate Message Reply
twprojects-create_milestoneCreate Milestone
twprojects-create_notebookCreate Notebook
twprojects-create_projectCreate Project
twprojects-create_project_categoryCreate Project Category
twprojects-create_project_templateCreate Project Template
twprojects-create_skillCreate Skill
twprojects-create_tagCreate Tag
twprojects-create_taskCreate Task
twprojects-create_tasklistCreate Tasklist
twprojects-create_teamCreate Team
twprojects-create_timelogCreate Timelog
twprojects-create_timerCreate Timer
twprojects-create_userCreate User
twprojects-create_workflowCreate Workflow
twprojects-create_workflow_stageCreate Workflow Stage
twprojects-get_commentGet Comment
twprojects-get_companyGet Company
twprojects-get_custom_fieldGet Custom Field
twprojects-get_custom_field_valueGet Custom Field Value
twprojects-get_custom_itemGet Custom Item
twprojects-get_custom_item_fieldGet Custom Item Field
twprojects-get_custom_item_recordGet Custom Item Record
twprojects-get_jobroleGet Job Role
twprojects-get_linkGet Link
twprojects-get_messageGet Message
twprojects-get_message_replyGet Message Reply
twprojects-get_milestoneGet Milestone
twprojects-get_notebookGet Notebook
twprojects-get_projectGet Project
twprojects-get_project_categoryGet Project Category
twprojects-get_skillGet Skill
twprojects-get_tagGet Tag
twprojects-get_taskGet Task
twprojects-get_tasklistGet Tasklist
twprojects-get_teamGet Team
twprojects-get_timelogGet Timelog
twprojects-get_timerGet Timer
twprojects-get_userGet User
twprojects-get_user_meGet Logged User
twprojects-get_workflowGet Workflow
twprojects-get_workflow_stageGet Workflow Stage
twprojects-link_project_to_workflowLink Project to Workflow
twprojects-list_activitiesList Activities
twprojects-list_calendar_eventsList Calendar Events
twprojects-list_calendarsList Calendars
twprojects-list_commentsList Comments
twprojects-list_companiesList Companies
twprojects-list_custom_field_valuesList Custom Field Values
twprojects-list_custom_fieldsList Custom Fields
twprojects-list_custom_item_fieldsList Custom Item Fields
twprojects-list_custom_item_recordsList Custom Item Records
twprojects-list_custom_itemsList Custom Items
twprojects-list_industriesList Industries
twprojects-list_jobrolesList Job Roles
twprojects-list_linksList Links
twprojects-list_message_repliesList Message Replies
twprojects-list_messagesList Messages
twprojects-list_milestonesList Milestones
twprojects-list_notebooksList Notebooks
twprojects-list_project_budgetsList Project Budgets
twprojects-list_project_categoriesList Project Categories
twprojects-list_project_templatesList Project Templates
twprojects-list_projectsList Projects
twprojects-list_skillsList Skills
twprojects-list_tagsList Tags
twprojects-list_tasklist_budgetsList Tasklist Budgets
twprojects-list_tasklistsList Tasklists
twprojects-list_tasksList Tasks
twprojects-list_teamsList Teams
twprojects-list_timelogsList Timelogs
twprojects-list_timersList Timers
twprojects-list_usersList Users
twprojects-list_workflow_stagesList Workflow Stages
twprojects-list_workflowsList Workflows
twprojects-move_task_to_workflow_stageMove Task to Workflow Stage
twprojects-pause_timerPause Timer
twprojects-resume_timerResume Timer
twprojects-searchSearch
twprojects-update_commentUpdate Comment
twprojects-update_companyUpdate Company
twprojects-update_custom_fieldUpdate Custom Field
twprojects-update_custom_field_valueUpdate Custom Field Value
twprojects-update_custom_itemUpdate Custom Item
twprojects-update_custom_item_fieldUpdate Custom Item Field
twprojects-update_custom_item_recordUpdate Custom Item Record
twprojects-update_jobroleUpdate Job Role
twprojects-update_linkUpdate Link
twprojects-update_messageUpdate Message
twprojects-update_message_replyUpdate MessageReply
twprojects-update_milestoneUpdate Milestone
twprojects-update_notebookUpdate Notebook
twprojects-update_projectUpdate Project
twprojects-update_project_categoryUpdate Project Category
twprojects-update_skillUpdate Skill
twprojects-update_tagUpdate Tag
twprojects-update_taskUpdate Task
twprojects-update_tasklistUpdate Tasklist
twprojects-update_teamUpdate Team
twprojects-update_timelogUpdate Timelog
twprojects-update_timerUpdate Timer
twprojects-update_userUpdate User
twprojects-update_workflowUpdate Workflow
twprojects-update_workflow_stageUpdate Workflow Stage
twprojects-users_workloadGet Users Workload
twspaces-create_categoryCreate Category
twspaces-create_commentCreate Comment
twspaces-create_pageCreate Page
twspaces-create_spaceCreate Space
twspaces-create_tagsCreate Tags
twspaces-delete_categoryDelete Category
twspaces-delete_commentDelete Comment
twspaces-delete_pageDelete Page
twspaces-delete_spaceDelete Space
twspaces-delete_tagDelete Tag
twspaces-duplicate_pageDuplicate Page
twspaces-get_categoryGet Category
twspaces-get_commentGet Comment
twspaces-get_homepageGet Space Homepage
twspaces-get_pageGet Page
twspaces-get_spaceGet Space
twspaces-get_tagGet Tag
twspaces-list_categoriesList Categories
twspaces-list_commentsList Comments
twspaces-list_pagesList Pages
twspaces-list_space_collaboratorsList Space Collaborators
twspaces-list_spacesList Spaces
twspaces-list_tagsList Tags
twspaces-searchSearch Spaces
twspaces-update_categoryUpdate Category
twspaces-update_commentUpdate Comment
twspaces-update_pageUpdate Page
twspaces-update_spaceUpdate Space
twspaces-update_tagUpdate Tag

Tools Details

Tool: twchat-get_conversation

Get a single Teamwork Chat conversation by ID.

ParametersTypeDescription
conversation_idintegerThe ID of the conversation to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twchat-get_current_user

Get the current authenticated Teamwork Chat user, including identity, counts (unread conversations/messages, mentions), and settings.

Tool: twchat-get_or_create_dm

Get the 1:1 direct-message conversation with a person, creating it if it does not exist yet. Returns the conversation (use its id with send_message). Use list_people to find user_id.

ParametersTypeDescription
user_idintegerThe ID of the person to get the direct-message conversation with.

This tool is read-only. It does not modify its environment.


Tool: twchat-list_conversations

List Teamwork Chat conversations the current user is a member of.

ParametersTypeDescription
include_message_datastringoptionalInclude the latest message in each conversation.
page_limitstringoptionalNumber of conversations to return (max 10).
page_offsetstringoptionalThe index position to start retrieving results from (not a page number).
search_termstringoptionalA search term to filter conversations by title.
sortstringoptionalSort order for the returned conversations.
statusstringoptionalFilter by conversation status.
typestringoptionalFilter by conversation type: "rooms" for group/channel conversations, "pair" for 1:1 direct messages.

This tool is read-only. It does not modify its environment.


Tool: twchat-list_messages

List messages within a Teamwork Chat conversation. Requires conversation_id.

ParametersTypeDescription
conversation_idintegerThe ID of the conversation to read messages from.
after_message_idstringoptionalReturn messages newer than this message ID (cursor).
before_message_idstringoptionalReturn messages older than this message ID (cursor).
created_afterstringoptionalReturn messages created after this time.
created_beforestringoptionalReturn messages created before this time.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of messages per page (1-200).
search_termstringoptionalA search term to filter messages by text content.

This tool is read-only. It does not modify its environment.


Tool: twchat-list_people

List people in the Teamwork Chat installation. Useful for resolving names to user IDs.

ParametersTypeDescription
page_limitstringoptionalNumber of people to return.
page_offsetstringoptionalThe index position to start retrieving results from (not a page number).
search_termstringoptionalA search term to filter people by name or email.

This tool is read-only. It does not modify its environment.


Tool: twchat-send_dm

Send a direct message to a person, resolving (or creating) the 1:1 conversation automatically. Requires user_id and body. Use list_people to find user_id.

ParametersTypeDescription
bodystringThe message text. Supports Markdown.
user_idintegerThe ID of the person to send the direct message to.

Tool: twchat-send_message

Send a message to a Teamwork Chat conversation. Requires conversation_id and body.

ParametersTypeDescription
bodystringThe message text. Supports Markdown.
conversation_idintegerThe ID of the conversation to post the message to.

Tool: twdesk-create_company

Create Desk company.

ParametersTypeDescription
descriptionstringThe description of the company.
detailsstringThe details of the company.
domainsstringThe domains for the company.
industrystringThe industry of the company.
kindstringThe kind of the company.
namestringThe name of the company.
notestringThe note for the company.
permissionstringThe permission level of the company.
websitestringThe website of the company.

Tool: twdesk-create_customer

Create customer.

ParametersTypeDescription
addressstringThe address of the customer.
emailstringThe email of the customer.
extraDatastringThe extra data of the customer.
facebookURLstringThe Facebook URL of the customer.
firstNamestringThe first name of the customer.
jobTitlestringThe job title of the customer.
lastNamestringThe last name of the customer.
linkedinURLstringThe LinkedIn URL of the customer.
mobilestringThe mobile number of the customer.
notesstringThe notes of the customer.
organizationstringThe organization of the customer.
phonestringThe phone number of the customer.
twitterHandlestringThe Twitter handle of the customer.

Tool: twdesk-create_file

Upload file. Attach the returned ID to tickets or messages.

ParametersTypeDescription
datastringThe content of the file as a base64-encoded string.
dispositionstringThe disposition of the file.
mimeTypestringThe MIME type of the file.
namestringThe name of the file.

Tool: twdesk-create_helpdoc_article

Create a new help doc article.

ParametersTypeDescription
contentsstringThe body content of the article.
descriptionstringA short description / summary of the article.
isPrivatestringSet to true to make the article private.
siteIDintegerThe ID of the help doc site to create the article in.
statusstringPublication status of the article (e.g. "published", "draft").
titlestringThe title of the article.

Tool: twdesk-create_priority

Create ticket priority.

ParametersTypeDescription
colorstringThe color of the priority.
namestringThe name of the priority.

Tool: twdesk-create_status

Create ticket status.

ParametersTypeDescription
colorstringThe color of the status.
displayOrderstringThe display order of the status.
namestringThe name of the status.

Tool: twdesk-create_tag

Create Desk tag.

ParametersTypeDescription
colorstringThe color of the tag.
namestringThe name of the tag.

Tool: twdesk-create_ticket

Create ticket.

ParametersTypeDescription
agentIdstringAgent the ticket is assigned to. Use twdesk-list_users to discover.
bccstringEmail addresses to BCC.
bodystringThe body of the ticket.
ccstringEmail addresses to CC.
customerEmailstringCustomer email; required when customerId is not given. Existing customers are matched, otherwise a new customer is created.
customerIdstringCustomer of the ticket. Use twdesk-list_customers to discover.
filesstringFile IDs to attach. Use twdesk-create_file to upload.
inboxIdintegerInbox of the ticket. Use twdesk-list_inboxes to discover.
notifyCustomerstringSet to true if the customer should be sent a copy of the ticket.
priorityIdstringPriority of the ticket. Use twdesk-list_priorities to discover.
statusIdstringStatus of the ticket. Use twdesk-list_statuses to discover.
subjectstringThe subject of the ticket.
tagsstringTags to associate with the ticket. Use twdesk-list_tags to discover.
typeIdstringTicket type. Use twdesk-list_ticket_types to discover.

Tool: twdesk-create_ticket_type

Create ticket type.

ParametersTypeDescription
displayOrderstringThe display order of the type.
enabledForFutureInboxesstringWhether the type is enabled for future inboxes.
namestringThe name of the ticket type.

Tool: twdesk-get_company

Get Desk company (customer organization).

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the company to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_customer

Get customer.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the customer to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_helpdoc_article

Get a help doc article by ID.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the help doc article to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_inbox

Get inbox.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the inbox to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_priority

Get ticket priority.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the priority to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_status

Get ticket status.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the status to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_tag

Get Desk tag.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the tag to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_ticket

Get ticket.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the ticket to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_ticket_type

Get ticket type.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the ticket type to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-get_user

Get support agent.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
idintegerThe ID of the user to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twdesk-list_companies

List Desk companies. Filter by name, domains, or kind.

ParametersTypeDescription
domainsstringThe domains of the company to filter by.
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
kindstringThe kind of the company to filter by.
namestringThe name of the company to filter by.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twdesk-list_customers

List customers. Filter by company or email.

ParametersTypeDescription
companyIDsstringThe IDs of the companies to filter by.
companyNamesstringThe names of the companies to filter by.
emailsstringThe emails of the customers to filter by.
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twdesk-list_inboxes

List inboxes. Filter by name or email.

ParametersTypeDescription
emailstringThe email of the inbox to filter by.
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
namestringThe name of the inbox to filter by.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twdesk-list_priorities

List ticket priorities. Filter by name or color.

ParametersTypeDescription
colorstringThe color of the priority to filter by.
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
namestringThe name of the priority to filter by.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twdesk-list_statuses

List ticket statuses. Filter by name, color, or code.

ParametersTypeDescription
codestringThe code of the status to filter by.
colorstringThe color of the status to filter by.
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
namestringThe name of the status to filter by.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twdesk-list_tags

List Desk tags. Filter by name, color, or inbox.

ParametersTypeDescription
colorstringThe color of the tag to filter by.
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
inboxIDsstringThe IDs of the inboxes to filter by.
namestringThe name of the tag to filter by.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twdesk-list_ticket_types

List ticket types. Filter by name or inbox.

ParametersTypeDescription
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
inboxIDsstringFilter by inbox. Use twdesk-list_inboxes to discover.
namestringThe name of the type to filter by.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twdesk-list_users

List support agents. For customers, use twdesk-list_customers.

ParametersTypeDescription
emailstringThe email addresses of the users to filter by.
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
firstNamestringThe first names of the users to filter by.
inboxIDsstringThe IDs of the inboxes to filter by.
isPartTimestringWhether to include part-time users in the results.
lastNamestringThe last names of the users to filter by.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twdesk-reply_ticket

Reply to a ticket. Use threadType=note for internal agent notes.

ParametersTypeDescription
bccstringEmail addresses to BCC.
bodystringThe body of the message.
ccstringEmail addresses to CC.
threadTypestring'message' is a customer-facing reply; 'note' is an internal agent note.
ticketIDintegerThe ID of the ticket that the message will be sent to.

Tool: twdesk-search_helpdoc_articles

Search help doc articles. Filter by search term, status, site, or category.

ParametersTypeDescription
categoryIDstringFilter by help doc category ID.
pagestringPage number (1-based).
pageSizestringNumber of results per page.
searchstringFree-text search term matched against article title and content.
siteIDstringFilter by help doc site ID.
statusstringFilter by article status (e.g. "published", "draft").

This tool is read-only. It does not modify its environment.


Tool: twdesk-search_tickets

Search tickets. Filter by inbox, customer, company, tag, status, priority, or user.

ParametersTypeDescription
companyIDsstringFilter by company. Use twdesk-list_companies to discover.
customerIDsstringFilter by customer. Use twdesk-list_customers to discover.
fieldsstringSparse fieldset: field names to include (e.g. ["id","name"]). Omit to receive all fields.
inboxIDsstringFilter by inbox. Use twdesk-list_inboxes to discover.
orderBystringThe field to order the results by.
orderDirectionstringThe direction to order the results by (asc, desc).
pagestringPage number for pagination of results.
pageSizestringNumber of results per page for pagination.
priorityIDsstringFilter by priority. Use twdesk-list_priorities to discover.
searchstringSearch term matched against subject, body, and other ticket fields.
statusIDsstringFilter by status. Use twdesk-list_statuses to discover.
tagIDsstringFilter by tag. Use twdesk-list_tags to discover.
userIDsstringFilter by user. Use twdesk-list_users to discover.

This tool is read-only. It does not modify its environment.


Tool: twdesk-update_company

Update Desk company.

ParametersTypeDescription
descriptionstringThe new description of the company.
detailsstringThe new details of the company.
domainsstringThe new domains for the company.
idintegerThe ID of the company to update.
industrystringThe new industry of the company.
kindstringThe new kind of the company.
namestringThe new name of the company.
notestringThe new note for the company.
permissionstringThe new permission level of the company.
websitestringThe new website of the company.

Tool: twdesk-update_customer

Update customer.

ParametersTypeDescription
addressstringThe new address of the customer.
emailstringThe new email of the customer.
extraDatastringThe new extra data of the customer.
facebookURLstringThe new Facebook URL of the customer.
firstNamestringThe new first name of the customer.
idintegerThe ID of the customer to update.
jobTitlestringThe new job title of the customer.
lastNamestringThe new last name of the customer.
linkedinURLstringThe new LinkedIn URL of the customer.
mobilestringThe new mobile number of the customer.
notesstringThe new notes of the customer.
organizationstringThe new organization of the customer.
phonestringThe new phone number of the customer.
twitterHandlestringThe new Twitter handle of the customer.

Tool: twdesk-update_helpdoc_article

Update an existing help doc article.

ParametersTypeDescription
contentsstringThe new body content of the article.
descriptionstringA short description / summary of the article.
idintegerThe ID of the help doc article to update.
isPrivatestringSet to true to make the article private.
statusstringPublication status (e.g. "published", "draft").
titlestringThe new title of the article.

Tool: twdesk-update_priority

Update ticket priority.

ParametersTypeDescription
colorstringThe color of the priority.
idintegerThe ID of the priority to update.
namestringThe new name of the priority.

Tool: twdesk-update_status

Update ticket status.

ParametersTypeDescription
colorstringThe color of the status.
displayOrderstringThe display order of the status.
idintegerThe ID of the status to update.
namestringThe new name of the status.

Tool: twdesk-update_tag

Update Desk tag.

ParametersTypeDescription
colorstringThe color of the tag.
idintegerThe ID of the tag to update.
namestringThe new name of the tag.

Tool: twdesk-update_ticket

Update ticket.

ParametersTypeDescription
agentIdstringAgent the ticket is assigned to. Use twdesk-list_users to discover.
bccstringEmail addresses to BCC.
bodystringThe body of the ticket.
ccstringEmail addresses to CC.
deleteTagsstringTags to remove from the ticket. Use twdesk-list_tags to discover.
idintegerThe ID of the ticket to update.
inboxIdstringInbox of the ticket. Use twdesk-list_inboxes to discover.
priorityIdstringPriority of the ticket. Use twdesk-list_priorities to discover.
statusIdstringStatus of the ticket. Use twdesk-list_statuses to discover.
subjectstringThe subject of the ticket.
tagsstringTags to associate with the ticket. Use twdesk-list_tags to discover.
typeIdstringTicket type. Use twdesk-list_ticket_types to discover.

Tool: twdesk-update_ticket_type

Update ticket type.

ParametersTypeDescription
displayOrderstringThe display order of the type.
enabledForFutureInboxesstringWhether the type is enabled for future inboxes.
idintegerThe ID of the ticket type to update.
namestringThe new name of the type.

Tool: twprojects-add_project_member

Add a user to a project.

ParametersTypeDescription
project_idintegerThe ID of the project to add the member to.
user_idsstringoptionalUsers to add.

Tool: twprojects-clone_project

Clone/copy an existing project or instantiate one from a template.

ParametersTypeDescription
idintegerThe ID of the project to clone.
company_idstringoptionalThe ID of the company associated with the new cloned project. If not provided, the company of the original project will be used.
days_offsetstringoptionalDaysOffset is the number of days to shift all scheduled dates in the cloned project relative to the base date. When cloning from a template, it defines the project duration span. When copying an existing project, it shifts the original start and end dates by this many days. If omitted, calculated automatically from the source project's date range.
descriptionstringoptionalThe description of the new cloned project. If not provided, the description of the original project will be used.
namestringoptionalThe name of the new cloned project. If not provided, the name of the original project will be used with an incremental suffix (e.g., 'Project Name (1)').
new_from_templatestringoptionalIndicates whether the new project should be a regular one created from a template.
target_datestringoptionalDesired start or end date for the cloned project (chosen by template_date_target). Only applies when new_from_template=true. Format: YYYYMMDD. Defaults to today.
template_date_targetstringoptionalSpecifies whether target_date represents the project's start or end date. When 'end', the start date is calculated by subtracting the template project's duration from target_date. Only applicable when new_from_template=true.
to_templatestringoptionalIndicates whether the new project should be set as a template.

Tool: twprojects-complete_task

Mark task complete.

ParametersTypeDescription
idintegerThe ID of the task to mark as complete.

Tool: twprojects-complete_timer

Stop a timer permanently and convert it to a timelog. Use pause_timer to pause without converting.

ParametersTypeDescription
idintegerThe ID of the timer to complete.

Tool: twprojects-create_comment

Create comment on a task, milestone, notebook, file, or link.

ParametersTypeDescription
bodystringThe content of the comment. The content can be added as text or HTML.
objectobjectThe object to create the comment for. It can be a tasks, milestones, files or notebooks.
content_typestringoptionalThe content type of the comment. It can be either 'TEXT' or 'HTML'.
notifystringoptionalWho to notify of the new comment.
notify_current_userstringoptionalWhether the current user should be notified about the new comment.

Tool: twprojects-create_company

Create company (aka client).

ParametersTypeDescription
namestringThe name of the company.
address_onestringoptionalThe first line of the address of the company.
address_twostringoptionalThe second line of the address of the company.
citystringoptionalThe city of the company.
country_codestringoptionalThe country code of the company, e.g., 'US' for the United States.
email_onestringoptionalThe primary email address of the company.
email_threestringoptionalThe tertiary email address of the company.
email_twostringoptionalThe secondary email address of the company.
faxstringoptionalThe fax number of the company.
industry_idstringoptionalThe ID of the industry the company belongs to.
manager_idstringoptionalThe ID of the user who manages the company.
phonestringoptionalThe phone number of the company.
profilestringoptionalA profile description for the company.
statestringoptionalThe state of the company.
tag_idsstringoptionalA list of tag IDs to associate with the company.
websitestringoptionalThe website of the company.
zipstringoptionalThe ZIP or postal code of the company.

Tool: twprojects-create_custom_field

Create custom field.

ParametersTypeDescription
entitystringThe type of entity this custom field can be applied to. Use 'all' for installation-level custom fields that are available across the workspace.
namestringThe display name of the custom field.
typestringThe data type of the custom field.
currency_codestringoptionalThe ISO currency code for 'currency' or 'financial' type custom fields.
descriptionstringoptionalAn optional description for the custom field.
formulastringoptionalThe formula expression for 'formula' type custom fields.
optionsstringoptionalType-specific options for the custom field. For 'dropdown' and 'multiselect' types, provide {"choices": [{"value": "...", "color": "#rrggbb"}, ...]}. For 'rating' type, provide {"icon": "star
project_idstringoptionalThe ID of the project to scope the custom field to. When omitted, the custom field is created at the installation level.
requiredstringoptionalWhether the custom field must have a value when set on an entity.
unitstringoptionalThe unit associated with the custom field, when applicable.

Tool: twprojects-create_custom_field_value

Set a custom field value on a task, project or company. The custom field must already exist and be applicable to the target entity.

ParametersTypeDescription
custom_field_idintegerThe ID of the custom field the value belongs to.
entitystringThe type of entity the custom field value is attached to.
entity_idintegerThe ID of the task, project or company the custom field value is attached to.
valuestringThe value to assign to the custom field. The concrete type depends on the custom field definition: strings for text fields, numbers for number fields, booleans for checkboxes, option IDs for dropdown fields (array of integers for multiselect), ISO-8601 date strings for date fields.
country_codestringoptionalThe country code for currency-type custom field values.
currency_codestringoptionalThe ISO currency code for currency-type custom field values.

Tool: twprojects-create_custom_item

Create a new custom item type (e.g. Contracts, Leads, Deals) on a project. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
display_namestringThe display name of the custom item type (e.g. "Contracts").
project_idintegerProject ID that will own the new custom item type.
descriptionstringoptionalAn optional human-readable description for the custom item type.
label_pluralstringoptionalPlural label for many records (e.g. "Contracts"). Defaults to the display name when omitted.
label_singularstringoptionalSingular label for one record (e.g. "Contract"). Defaults to the display name when omitted.

Tool: twprojects-create_custom_item_field

Add a field (column) to a custom item type. Field types include text, number, dropdown, multiselect, checkbox, url, user, date, time and datetime. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
custom_item_idintegerCustom item type ID that will own the new field.
display_namestringHuman-readable name of the field (e.g. "Status").
typestringField data type.
definitionstringoptionalOptional type-specific configuration as a JSON object. Examples: for number-decimal fields {"precision": "2", "unit": {"type": "currency"}}; for user fields {"limit": 1, "source": "workspace"}. See the API docs for the exact shape per type.
optionsstringoptionalChoices for dropdown/multiselect fields. Each option is {label: "Active", color: "#22c55e"}.
position_after_idstringoptionalPlace this field after the given field ID. Null appends to the end.
tw_typestringoptionalOptional sub-classification for dropdown fields. Use "status" for a Status field.

Tool: twprojects-create_custom_item_record

Create a record (row) on a custom item type. For example, add a Contract on the Contracts type. Pass field values by name; the tool resolves names to the API's internal IDs. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
custom_item_idintegerCustom item type ID that will own the new record.
namestringDisplay name of the record (e.g. "Acme Inc Contract").
field_valuesstringoptionalField values to set on the record. Each entry is {field_name, value}. Field names are matched case-insensitively against the custom item type's fields. Values are coerced by field type: dropdown/multiselect accept option labels or option twIds; date/time/datetime accept ISO-8601 strings; checkbox accepts bool or yes/no/true/false; number accepts numeric or numeric string; user accepts a user ID (or array of IDs for multi-user fields). To clear a field, send null.
position_after_idstringoptionalPlace the record after the given record ID. Null appends to the end.
section_idstringoptionalOptional section ID to place the record in.

Tool: twprojects-create_jobrole

Create job role.

ParametersTypeDescription
namestringThe name of the job role.

Tool: twprojects-create_link

Create link.

ParametersTypeDescription
codestringThe URL of the link. This is the actual web address that the link points to.
project_idintegerThe ID of the project to create the link in.
descriptionstringoptionalThe description of the link. Longer text that provides detailed information about the link.
notifystringoptionalWho to notify of the new link.
notify_current_userstringoptionalWhether the current user should be notified about the new link.
tag_idsstringoptionalA list of tag IDs to associate with the link.
titlestringoptionalThe title of the link, which provides a brief summary of the purpose of the link.

Tool: twprojects-create_message

Create message in a project.

ParametersTypeDescription
bodystringThe body of the message.
project_idintegerThe ID of the project to create the message in.
titlestringThe title of the message.
notifystringoptionalWho to notify of the new message.
notify_current_userstringoptionalWhether the current user should be notified about the new message.

Tool: twprojects-create_message_reply

Create message reply.

ParametersTypeDescription
bodystringThe body of the message reply.
message_idintegerThe ID of the message to create the reply in.
notifystringoptionalWho to notify of the new reply.
notify_current_userstringoptionalWhether the current user should be notified about the new message reply.

Tool: twprojects-create_milestone

Create milestone in a project.

ParametersTypeDescription
assigneesobjectAssignees for the milestone.
due_datestringThe due date of the milestone (format: YYYYMMDD). Used for related tasks without their own due date.
namestringThe name of the milestone.
project_idintegerThe ID of the project to create the milestone in.
descriptionstringoptionalA description of the milestone.
tag_idsstringoptionalA list of tag IDs to associate with the milestone.
tasklist_idsstringoptionalTasklists to associate with the milestone.

Tool: twprojects-create_notebook

Create notebook in a project.

ParametersTypeDescription
contentsstringThe contents of the notebook.
namestringThe name of the notebook.
project_idintegerThe ID of the project to create the notebook in.
typestringThe type of the notebook.
descriptionstringoptionalA description of the notebook.
tag_idsstringoptionalA list of tag IDs to associate with the notebook.

Tool: twprojects-create_project

Create project.

ParametersTypeDescription
namestringThe name of the project.
category_idstringoptionalThe ID of the category to which the project belongs.
company_idstringoptionalThe ID of the company associated with the project.
descriptionstringoptionalThe description of the project.
end_atstringoptionalEnd date of the project (format: YYYYMMDD).
owned_idstringoptionalThe ID of the user who owns the project.
start_atstringoptionalStart date of the project (format: YYYYMMDD).
tag_idsstringoptionalA list of tag IDs to associate with the project.

Tool: twprojects-create_project_category

Create project category.

ParametersTypeDescription
namestringThe name of the project category.
colorstringoptionalThe color of the project category in hex format (e.g., #FF5733).
parent_idstringoptionalThe ID of the parent project category, if any. This allows for nested categories.

Tool: twprojects-create_project_template

Create project template.

ParametersTypeDescription
namestringThe name of the project template.
category_idstringoptionalThe ID of the category to which the project template belongs.
company_idstringoptionalThe ID of the company associated with the project template.
descriptionstringoptionalThe description of the project template.
end_atstringoptionalEnd date of the project template (format: YYYYMMDD).
owned_idstringoptionalThe ID of the user who owns the project template.
start_atstringoptionalStart date of the project template (format: YYYYMMDD).
tag_idsstringoptionalA list of tag IDs to associate with the project template.

Tool: twprojects-create_skill

Create skill.

ParametersTypeDescription
namestringThe name of the skill.
user_idsstringoptionalThe user IDs associated with the skill.

Tool: twprojects-create_tag

Create tag.

ParametersTypeDescription
namestringThe name of the tag. It must have less than 50 characters.
project_idstringoptionalThe ID of the project to associate the tag with. This is for project-scoped tags.

Tool: twprojects-create_task

Create task in a tasklist.

ParametersTypeDescription
namestringThe name of the task.
tasklist_idintegerTasklist ID. Use twprojects-list_tasklists to find one.
assigneesstringoptionalAssignees for the task.
change_followersstringoptionalFollowers of any task changes.
comment_followersstringoptionalFollowers of any task comments.
complete_followersstringoptionalFollowers of any task completions.
descriptionstringoptionalThe description of the task. Support for plain text and Markdown formatting.
due_datestringoptionalThe due date of the task. If omitted, falls back to the milestone due date when one is set.
estimated_minutesstringoptionalThe estimated time to complete the task in minutes.
parent_task_idstringoptionalThe ID of the parent task if creating a subtask.
predecessorsstringoptionalTask dependencies that must be completed before this task can start.
prioritystringoptionalThe priority of the task.
progressstringoptionalThe progress of the task, as a percentage (0-100). Only whole numbers are allowed.
start_datestringoptionalThe start date of the task.
tag_idsstringoptionalA list of tag IDs to associate with the task.

Tool: twprojects-create_tasklist

Create tasklist in a project.

ParametersTypeDescription
namestringThe name of the tasklist.
project_idintegerThe ID of the project to create the tasklist in.
descriptionstringoptionalThe description of the tasklist.
milestone_idstringoptionalThe ID of the milestone to associate with the tasklist.

Tool: twprojects-create_team

Create team.

ParametersTypeDescription
namestringThe name of the team.
company_idstringoptionalThe ID of the company. This is used to create a team scoped for a specific company.
descriptionstringoptionalThe description of the team.
handlestringoptionalThe handle of the team. It is a unique identifier for the team. It must not have spaces or special characters.
parent_team_idstringoptionalThe ID of the parent team. This is used to create a hierarchy of teams.
project_idstringoptionalThe ID of the project. This is used to create a team scoped for a specific project.
user_idsstringoptionalUsers to add to the team.

Tool: twprojects-create_timelog

Create timelog entry against a project or task.

ParametersTypeDescription
datestringThe date of the timelog.
hoursintegerThe number of hours spent on the timelog. Must be a positive integer.
minutesintegerMinutes spent on the timelog. Must be a positive integer less than 60; otherwise increment hours instead.
timestringThe time of the timelog in the format HH:MM:SS.
billablestringoptionalIf true, the timelog is billable.
descriptionstringoptionalA description of the timelog.
is_utcstringoptionalIf true, the time is in UTC.
project_idstringoptionalProject the timelog is logged against. Provide exactly one of project_id or task_id.
tag_idsstringoptionalA list of tag IDs to associate with the timelog.
task_idstringoptionalTask the timelog is logged against. Provide exactly one of project_id or task_id.
user_idstringoptionalUser the timelog is logged for. Defaults to the authenticated user.

Tool: twprojects-create_timer

Create and start a timer.

ParametersTypeDescription
project_idintegerThe ID of the project to associate the timer with.
billablestringoptionalIf true, the timer is billable.
descriptionstringoptionalA description of the timer.
runningstringoptionalIf true, the timer will start running immediately.
secondsstringoptionalThe number of seconds to set the timer for.
stop_running_timersstringoptionalIf true, any other running timers will be stopped when this timer is created.
task_idstringoptionalThe ID of the task to associate the timer with.

Tool: twprojects-create_user

Create user.

ParametersTypeDescription
emailstringThe email address of the user.
first_namestringThe first name of the user.
last_namestringThe last name of the user.
adminstringoptionalIndicates whether the user is an administrator.
company_idstringoptionalThe ID of the client/company to which the user belongs.
titlestringoptionalThe job title of the user, such as 'Project Manager' or 'Senior Software Developer'.
typestringoptionalThe type of user, such as 'account', 'collaborator', or 'contact'.

Tool: twprojects-create_workflow

Create workflow.

ParametersTypeDescription
namestringThe name of the workflow.

Tool: twprojects-create_workflow_stage

Create workflow stage.

ParametersTypeDescription
namestringThe name of the workflow stage.
workflow_idintegerThe ID of the workflow to add the stage to.

Tool: twprojects-get_comment

Get comment.

ParametersTypeDescription
idintegerThe ID of the comment to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_company

Get company (aka client).

ParametersTypeDescription
idintegerThe ID of the company to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_custom_field

Get custom field.

ParametersTypeDescription
idintegerThe ID of the custom field to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_custom_field_value

Get a single custom field value from a task, project or company.

ParametersTypeDescription
entitystringThe type of entity the custom field value is attached to.
entity_idintegerThe ID of the task, project or company the custom field value belongs to.
value_idintegerThe ID of the custom field value entry to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_custom_item

Get a custom item type with its fields and sections inline, so you can see its schema before creating or updating records. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
idintegerCustom item type ID to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_custom_item_field

Get a single field on a custom item type. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
custom_item_idintegerCustom item type ID the field belongs to.
idintegerField ID.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_custom_item_record

Get a single record. Field values come back keyed by display name with dropdown values translated to their human-readable labels. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
custom_item_idintegerCustom item type ID the record belongs to.
idintegerRecord ID.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_jobrole

Get job role.

ParametersTypeDescription
idintegerThe ID of the job role to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_link

Get link.

ParametersTypeDescription
idintegerThe ID of the link to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_message

Get message.

ParametersTypeDescription
idintegerThe ID of the message to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_message_reply

Get message reply.

ParametersTypeDescription
idintegerThe ID of the message reply to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_milestone

Get milestone.

ParametersTypeDescription
idintegerThe ID of the milestone to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_notebook

Get notebook.

ParametersTypeDescription
idintegerThe ID of the notebook to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_project

Get project.

ParametersTypeDescription
idintegerThe ID of the project to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_project_category

Get project category.

ParametersTypeDescription
idintegerThe ID of the project category to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_skill

Get skill.

ParametersTypeDescription
idintegerThe ID of the skill to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_tag

Get tag.

ParametersTypeDescription
idintegerThe ID of the tag to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_task

Get task.

ParametersTypeDescription
idintegerThe ID of the task to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_tasklist

Get tasklist.

ParametersTypeDescription
idintegerThe ID of the tasklist to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_team

Get team.

ParametersTypeDescription
idintegerThe ID of the team to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_timelog

Get timelog.

ParametersTypeDescription
idintegerThe ID of the timelog to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_timer

Get timer.

ParametersTypeDescription
idintegerThe ID of the timer to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_user

Get user.

ParametersTypeDescription
idintegerThe ID of the user to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_user_me

Get the currently authenticated user.

Tool: twprojects-get_workflow

Get workflow.

ParametersTypeDescription
idintegerThe ID of the workflow to get.

This tool is read-only. It does not modify its environment.


Tool: twprojects-get_workflow_stage

Get workflow stage.

ParametersTypeDescription
idintegerThe ID of the workflow stage to get.
workflow_idintegerThe ID of the workflow that owns the stage.

This tool is read-only. It does not modify its environment.


Tool: twprojects-link_project_to_workflow

Link a project to a workflow so its tasks track through workflow stages.

ParametersTypeDescription
project_idintegerThe ID of the project to link to the workflow.
workflow_idintegerThe ID of the workflow to link the project to.

Tool: twprojects-list_activities

List recent activity events. Scope by project_id or omit for site-wide.

ParametersTypeDescription
end_datestringoptionalEnd of the activity window.
log_item_typesstringoptionalFilter activities by item types.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project to retrieve activities from. Omit to list activities across all projects.
start_datestringoptionalStart of the activity window.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_calendar_events

List events from a calendar, including time-blocking events that link a calendar slot to a Teamwork project, task or timelog. Use twprojects-list_calendars to find the calendar ID; the calendar of type 'blocked_time' holds the account's time-blocking events.

ParametersTypeDescription
calendar_idintegerThe ID of the calendar to list events from.
cursorstringoptionalCursor for fetching the next page of results.
ended_before_datestringoptionalFilter events that end before this date (format: YYYY-MM-DD).
limitstringoptionalMaximum number of events to return.
started_after_datestringoptionalFilter events that start after this date (format: YYYY-MM-DD).
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_calendars

List calendars. Calendars hold events such as meetings, out-of-office periods and time-blocking entries; the calendar of type 'blocked_time' holds the account's time-blocking events.

ParametersTypeDescription
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_comments

List comments. Scope by one of task_id, milestone_id, notebook_id, link_id, or file_version_id; omit all for site-wide.

ParametersTypeDescription
file_version_idstringoptionalThe ID of the file version to retrieve comments for. Each file can have multiple versions, and comments can be associated with specific versions.
link_idstringoptionalThe ID of the link to retrieve comments for. Provide this to scope comments to a link.
milestone_idstringoptionalThe ID of the milestone to retrieve comments for. Provide this to scope comments to a milestone.
notebook_idstringoptionalThe ID of the notebook to retrieve comments for. Provide this to scope comments to a notebook.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter comments by name.
task_idstringoptionalThe ID of the task to retrieve comments for. Provide this to scope comments to a task.
updated_afterstringoptionalFilter comments updated after. Defaults to the last 3 months.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_companies

List companies (aka clients).

ParametersTypeDescription
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter companies by name. Each word from the search term is used to match against the company name.
tag_idsstringoptionalA list of tag IDs to filter companies by tags.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_custom_field_values

List the custom field values of a task, project or company.

ParametersTypeDescription
entitystringThe type of entity to list custom field values for.
entity_idintegerThe ID of the task, project or company to list custom field values for.
custom_field_idsstringoptionalFilter by custom field.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_custom_fields

List custom fields.

ParametersTypeDescription
entitiesstringoptionalFilter custom fields by entity type.
idsstringoptionalCustom field IDs to retrieve.
include_site_levelstringoptionalWhether to also include installation-level custom fields when filtering by project.
only_project_levelstringoptionalWhether to return only project-level custom fields.
only_site_levelstringoptionalWhether to return only installation-level custom fields.
order_bystringoptionalThe field to sort the results by.
order_modestringoptionalThe direction to sort the results in.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idsstringoptionalFilter custom fields by project.
search_termstringoptionalA search term to filter custom fields by name.
show_deletedstringoptionalWhether to include deleted custom fields in the results.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_custom_item_fields

List fields on a custom item type. Each entry includes the twId you need when writing record values. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
custom_item_idintegerCustom item type ID to list fields for.
idsstringoptionalRestrict to these field IDs.
order_modestringoptionalThe direction to order the results by (asc, desc).
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter custom item fields by display name.
show_deletedstringoptionalInclude deleted fields.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_custom_item_records

List records on a custom item type. Returns each record with field values keyed by display name. Use the section_ids filter to scope to a specific section. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
custom_item_idintegerCustom item type ID to list records for.
idsstringoptionalRestrict to these record IDs.
order_bystringoptionalField to sort by.
order_modestringoptionalThe direction to order the results by (asc, desc).
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter custom item records by name.
section_idsstringoptionalRestrict to records in these sections.
show_deletedstringoptionalInclude deleted records.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_custom_items

List the custom item types defined on a project. Returns each type's id, display name and labels — call get_custom_item to see a type's fields and sections. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
project_idintegerProject ID to list custom item types for.
idsstringoptionalRestrict to these custom item type IDs.
order_bystringoptionalField to sort by.
order_modestringoptionalThe direction to order the results by (asc, desc).
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter custom items by display name or labels.
show_deletedstringoptionalInclude deleted custom item types.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_industries

List supported company (aka client) industries.

Tool: twprojects-list_jobroles

List job roles.

ParametersTypeDescription
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter job roles by name, or assigned users. The job role will be selected if each word of the term matches the name, or assigned user first or last name, not requiring that the word matches are in the same field.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_links

List links.

ParametersTypeDescription
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project to filter links by.
search_termstringoptionalA search term to filter links by title or description. Each word from the search term is used to match against the link title or description. The link will be selected if each word of the term matches the link title or description, not requiring that the word matches are in the same field.
tag_idsstringoptionalA list of tag IDs to filter links by tags.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_message_replies

List replies under a message thread. Filter by message_ids or project_ids.

ParametersTypeDescription
message_idsstringoptionalFilter by message.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idsstringoptionalFilter by project.
search_termstringoptionalA search term to filter message replies by body or title. Each word from the search term is used to match against the message reply body or title. The message reply will be selected if each word of the term matches the message reply body or title, not requiring that the word matches are in the same field.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_messages

List project messages (top-level posts). Use twprojects-list_message_replies for thread replies.

ParametersTypeDescription
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idsstringoptionalFilter messages by project.
search_termstringoptionalA search term to filter messages by body or title. Each word from the search term is used to match against the message body or title. The message will be selected if each word of the term matches the message body or title, not requiring that the word matches are in the same field.
tag_idsstringoptionalA list of tag IDs to filter messages by tags.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_milestones

List milestones. Scope by project_id or omit for site-wide.

ParametersTypeDescription
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project from which to retrieve milestones. Omit to list milestones across all projects.
search_termstringoptionalA search term to filter milestones by name. Each word from the search term is used to match against the milestone name and description. The milestone will be selected if each word of the term matches the milestone name or description, not requiring that the word matches are in the same field.
tag_idsstringoptionalA list of tag IDs to filter milestones by tags.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_notebooks

List notebooks.

ParametersTypeDescription
include_contentsstringoptionalIf true, include notebook contents in the response.
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idsstringoptionalFilter notebooks by project.
search_termstringoptionalA search term to filter notebooks by name or description. The notebook will be selected if each word of the term matches the notebook name or description, not requiring that the word matches are in the same field.
tag_idsstringoptionalA list of tag IDs to filter notebooks by tags.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_project_budgets

List project budgets (top-level project financial budgets). Filter by project_ids or status.

ParametersTypeDescription
cursorstringoptionalCursor for fetching the next page of results.
limitstringoptionalMaximum number of budgets to return.
page_sizestringoptionalNumber of results per page for pagination.
project_idsstringoptionalFilter budgets by project.
statusstringoptionalFilter budgets by status.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_project_categories

List project categories.

ParametersTypeDescription
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter project categories by name.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_project_templates

List project templates.

ParametersTypeDescription
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_category_idsstringoptionalFilter project templates by category.
search_termstringoptionalA search term to filter project templates by name or description.
tag_idsstringoptionalA list of tag IDs to filter project templates by tags.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_projects

List projects.

ParametersTypeDescription
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_category_idsstringoptionalFilter projects by category.
search_termstringoptionalA search term to filter projects by name or description.
tag_idsstringoptionalA list of tag IDs to filter projects by tags.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_skills

List skills.

ParametersTypeDescription
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter skills by name, or assigned users. The skill will be selected if each word of the term matches the name, or assigned user first or last name, not requiring that the word matches are in the same field.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_tags

List tags.

ParametersTypeDescription
item_typestringoptionalFilter tags by item type.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idsstringoptionalFilter by project.
search_termstringoptionalA search term to filter tags by name. Each word from the search term is used to match against the tag name.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_tasklist_budgets

List tasklist budgets nested under a project budget. Requires project_budget_id.

ParametersTypeDescription
project_budget_idintegerThe ID of the project budget to list tasklist budgets for.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_tasklists

List tasklists. Scope by project_id or omit for site-wide.

ParametersTypeDescription
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project from which to retrieve tasklists. Omit to list tasklists across all projects.
search_termstringoptionalA search term to filter tasklists by name.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_tasks

List tasks with structured filters (tasklist_id, project_id, or site-wide). For keyword search use search.

ParametersTypeDescription
assignee_user_idsstringoptionalFilter tasks by assignee.
completed_afterstringoptionalFilter tasks completed after.
completed_beforestringoptionalFilter tasks completed before.
created_afterstringoptionalFilter tasks created after.
created_beforestringoptionalFilter tasks created before.
created_by_user_idsstringoptionalFilter tasks by creator.
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project from which to retrieve tasks. Omit to list tasks across all projects.
search_termstringoptionalA search term to filter tasks by name.
tag_idsstringoptionalA list of tag IDs to filter tasks by tags.
tasklist_idstringoptionalThe ID of the tasklist from which to retrieve tasks. Takes precedence over project_id.
updated_afterstringoptionalFilter tasks updated after.
updated_beforestringoptionalFilter tasks updated before.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_teams

List teams. Scope by company_id or project_id, or omit for site-wide.

ParametersTypeDescription
company_idstringoptionalThe ID of the company from which to retrieve teams. Omit to list teams across all companies.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project from which to retrieve teams. Omit to list teams across all projects.
search_termstringoptionalA search term to filter teams by name or handle.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_timelogs

List timelogs. Scope by project_id or task_id, or omit for site-wide.

ParametersTypeDescription
assigned_company_idsstringoptionalFilter timelogs by assigned company.
assigned_team_idsstringoptionalFilter timelogs by assigned team.
assigned_user_idsstringoptionalFilter timelogs by assigned user.
end_datestringoptionalEnd of the timelog window.
match_all_tagsstringoptionalIf true, match all tags; if false, match any.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project from which to retrieve timelogs. Omit to list timelogs across all projects.
start_datestringoptionalStart of the timelog window.
tag_idsstringoptionalA list of tag IDs to filter timelogs by tags.
task_idstringoptionalThe ID of the task from which to retrieve timelogs. Omit to list timelogs across all tasks.
ticketIdsstringoptionalFilter timelogs by associated desk ticket.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_timers

List timers.

ParametersTypeDescription
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project to filter timers by. Only timers associated with this project will be returned.
running_timers_onlystringoptionalIf true, only running timers are returned.
task_idstringoptionalThe ID of the task to filter timers by. Only timers associated with this task will be returned.
user_idstringoptionalThe ID of the user to filter timers by. Only timers associated with this user will be returned.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_users

List users. Scope by project_id or filter by type (account/collaborator/contact).

ParametersTypeDescription
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project from which to retrieve users. Omit to list users across all projects.
search_termstringoptionalA search term to filter users by first or last names, or e-mail. The user will be selected if each word of the term matches the first or last name, or e-mail, not requiring that the word matches are in the same field.
typestringoptionalType of user to filter by. The available options are account, collaborator or contact.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_workflow_stages

List workflow stages.

ParametersTypeDescription
workflow_idintegerThe ID of the workflow whose stages to list.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-list_workflows

List workflows.

ParametersTypeDescription
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
search_termstringoptionalA search term to filter workflows by name.
verbosestringoptionalIf false, returns id + name only — useful when scanning many results.

This tool is read-only. It does not modify its environment.


Tool: twprojects-move_task_to_workflow_stage

Move a task to a workflow stage.

ParametersTypeDescription
stage_idintegerThe ID of the workflow stage to move the task to.
task_idintegerThe ID of the task to move.
workflow_idintegerThe ID of the workflow that contains the target stage.

Tool: twprojects-pause_timer

Pause a running timer; can be resumed later. Use complete_timer to stop permanently.

ParametersTypeDescription
idintegerThe ID of the timer to pause.

Tool: twprojects-resume_timer

Resume a paused timer back to running.

ParametersTypeDescription
idintegerThe ID of the timer to resume.

Tool: twprojects-search

Cross-entity keyword search across projects, tasks, files, messages, and more.

ParametersTypeDescription
search_termstringA search term to to look for items.
cursorstringoptionalCursor for pagination of results.
extended_searchstringoptionalWhether to perform an extended search, which includes items updated more than 5 years ago.
include_completed_itemsstringoptionalWhether to include completed items in the search results.
limitstringoptionalNumber of results per page for pagination.
project_idstringoptionalThe ID of the project to limit the search to.
updated_afterstringoptionalOnly include items updated after this date.

This tool is read-only. It does not modify its environment.


Tool: twprojects-update_comment

Update comment.

ParametersTypeDescription
bodystringThe content of the comment. The content can be added as text or HTML.
idintegerThe ID of the comment to update.
content_typestringoptionalThe content type of the comment. It can be either 'TEXT' or 'HTML'.
notifystringoptionalWho to notify of the comment change.
notify_current_userstringoptionalWhether the current user should be notified about the comment change.

Tool: twprojects-update_company

Update company (aka client).

ParametersTypeDescription
idintegerThe ID of the company to update.
address_onestringoptionalThe first line of the address of the company.
address_twostringoptionalThe second line of the address of the company.
citystringoptionalThe city of the company.
country_codestringoptionalThe country code of the company, e.g., 'US' for the United States.
email_onestringoptionalThe primary email address of the company.
email_threestringoptionalThe tertiary email address of the company.
email_twostringoptionalThe secondary email address of the company.
faxstringoptionalThe fax number of the company.
industry_idstringoptionalThe ID of the industry the company belongs to.
manager_idstringoptionalThe ID of the user who manages the company.
namestringoptionalThe name of the company.
phonestringoptionalThe phone number of the company.
profilestringoptionalA profile description for the company.
statestringoptionalThe state of the company.
tag_idsstringoptionalA list of tag IDs to associate with the company.
websitestringoptionalThe website of the company.
zipstringoptionalThe ZIP or postal code of the company.

Tool: twprojects-update_custom_field

Update custom field.

ParametersTypeDescription
idintegerThe ID of the custom field to update.
currency_codestringoptionalThe ISO currency code for 'currency' or 'financial' type custom fields.
descriptionstringoptionalAn optional description for the custom field.
formulastringoptionalThe formula expression for 'formula' type custom fields.
namestringoptionalThe display name of the custom field.
optionsstringoptionalType-specific options for the custom field. For 'dropdown' and 'multiselect' types, provide {"choices": [{"value": "...", "color": "#rrggbb"}, ...]}. For 'rating' type, provide {"icon": "star
requiredstringoptionalWhether the custom field must have a value when set on an entity.
unitstringoptionalThe unit associated with the custom field, when applicable.

Tool: twprojects-update_custom_field_value

Update a custom field value on a task, project or company.

ParametersTypeDescription
custom_field_idintegerThe ID of the custom field the value belongs to.
entitystringThe type of entity the custom field value is attached to.
entity_idintegerThe ID of the task, project or company the custom field value belongs to.
value_idintegerThe ID of the custom field value entry to update.
country_codestringoptionalThe country code for currency-type custom field values.
currency_codestringoptionalThe ISO currency code for currency-type custom field values.
valuestringoptionalThe value to assign to the custom field. The concrete type depends on the custom field definition: strings for text fields, numbers for number fields, booleans for checkboxes, option IDs for dropdown fields (array of integers for multiselect), ISO-8601 date strings for date fields.

Tool: twprojects-update_custom_item

Update a custom item type's display name, description, or labels. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
idintegerCustom item type ID to update.
descriptionstringoptionalNew description for the custom item type.
display_namestringoptionalNew display name for the custom item type.
label_pluralstringoptionalNew plural label.
label_singularstringoptionalNew singular label.

Tool: twprojects-update_custom_item_field

Update a field on a custom item type. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
custom_item_idintegerCustom item type ID the field belongs to.
idintegerField ID to update.
definitionstringoptionalReplacement type-specific configuration as a JSON object.
display_namestringoptionalNew display name.
position_after_idstringoptionalMove this field after the given field ID.

Tool: twprojects-update_custom_item_record

Update a record on a custom item type. Only the fields you supply are changed; others are left as-is. Set section_id to null to remove the record from any section. Custom items are user-defined entity types — Contracts, Leads, Deals, or anything else a customer has set up on a project. Use these tools when the user refers to an entity that is NOT a built-in Teamwork concept (Task, Tasklist, Project, Milestone, Comment, Notebook, Company, Team, User, Tag). If you don't recognise an entity name in the user's request, assume it is a custom item and call twprojects-list_custom_items on the relevant project to confirm.

ParametersTypeDescription
custom_item_idintegerCustom item type ID the record belongs to.
idintegerRecord ID to update.
clear_sectionstringoptionalSet to true to explicitly clear the record's section. Use this instead of section_id when you want null semantics.
field_valuesstringoptionalField values to set on the record. Each entry is {field_name, value}. Field names are matched case-insensitively against the custom item type's fields. Values are coerced by field type: dropdown/multiselect accept option labels or option twIds; date/time/datetime accept ISO-8601 strings; checkbox accepts bool or yes/no/true/false; number accepts numeric or numeric string; user accepts a user ID (or array of IDs for multi-user fields). To clear a field, send null.
namestringoptionalNew display name for the record.
position_after_idstringoptionalMove the record after the given record ID.
section_idstringoptionalNew section ID, or null to remove the record from any section.

Tool: twprojects-update_jobrole

Update job role.

ParametersTypeDescription
idintegerThe ID of the job role to update.
namestringoptionalThe name of the job role.

Tool: twprojects-update_link

Update link.

ParametersTypeDescription
idintegerThe ID of the link to update.
codestringoptionalThe URL of the link. This is the actual web address that the link points to.
descriptionstringoptionalThe description of the link. Longer text that provides detailed information about the link.
notifystringoptionalWho to notify of the link update.
notify_current_userstringoptionalWhether the current user should be notified about the new link.
tag_idsstringoptionalA list of tag IDs to associate with the link.
titlestringoptionalThe title of the link, which provides a brief summary of the purpose of the link.

Tool: twprojects-update_message

Update message.

ParametersTypeDescription
idintegerThe ID of the message to update.
bodystringoptionalThe body of the message.
notifystringoptionalWho to notify of the message update.
notify_current_userstringoptionalWhether the current user should be notified about the new message.
project_idstringoptionalThe ID of the project to create the message in.
titlestringoptionalThe title of the message.

Tool: twprojects-update_message_reply

Update message reply.

ParametersTypeDescription
idintegerThe ID of the message reply to update.
bodystringoptionalThe body of the message reply.
notifystringoptionalWho to notify of the reply update.
notify_current_userstringoptionalWhether the current user should be notified about the new messageReply.

Tool: twprojects-update_milestone

Update milestone.

ParametersTypeDescription
idintegerThe ID of the milestone to update.
assigneesstringoptionalAssignees for the milestone.
descriptionstringoptionalA description of the milestone.
due_datestringoptionalThe due date of the milestone (format: YYYYMMDD). Used for related tasks without their own due date.
namestringoptionalThe name of the milestone.
tag_idsstringoptionalA list of tag IDs to associate with the milestone.
tasklist_idsstringoptionalTasklists to associate with the milestone.

Tool: twprojects-update_notebook

Update notebook.

ParametersTypeDescription
idintegerThe ID of the notebook to update.
contentsstringoptionalThe contents of the notebook.
descriptionstringoptionalA description of the notebook.
namestringoptionalThe name of the notebook.
tag_idsstringoptionalA list of tag IDs to associate with the notebook.
typestringoptionalThe type of the notebook.

Tool: twprojects-update_project

Update project.

ParametersTypeDescription
idintegerThe ID of the project to update.
category_idstringoptionalThe ID of the category to which the project belongs.
company_idstringoptionalThe ID of the company associated with the project.
descriptionstringoptionalThe description of the project.
end_atstringoptionalEnd date of the project (format: YYYYMMDD).
namestringoptionalThe name of the project.
owned_idstringoptionalThe ID of the user who owns the project.
start_atstringoptionalStart date of the project (format: YYYYMMDD).
statusstringoptionalThe status of the project.
tag_idsstringoptionalA list of tag IDs to associate with the project.

Tool: twprojects-update_project_category

Update project category.

ParametersTypeDescription
idintegerThe ID of the project category to update.
colorstringoptionalThe color of the project category in hex format (e.g., #FF5733).
namestringoptionalThe name of the project category.
parent_idstringoptionalThe ID of the parent project category, if any. This allows for nested categories.

Tool: twprojects-update_skill

Update skill.

ParametersTypeDescription
idintegerThe ID of the skill to update.
namestringoptionalThe name of the skill.
user_idsstringoptionalThe user IDs associated with the skill.

Tool: twprojects-update_tag

Update tag.

ParametersTypeDescription
idintegerThe ID of the tag to update.
namestringoptionalThe name of the tag. It must have less than 50 characters.
project_idstringoptionalThe ID of the project to associate the tag with. This is for project-scoped tags.

Tool: twprojects-update_task

Update task.

ParametersTypeDescription
idintegerThe ID of the task to update.
assigneesstringoptionalAssignees for the task. To remove all assignees, use clear_assignees instead.
change_followersstringoptionalFollowers of any task changes.
clear_assigneesstringoptionalIf true, removes all assignees from the task, leaving it unassigned. Cannot be combined with a non-empty assignees value.
comment_followersstringoptionalFollowers of any task comments.
complete_followersstringoptionalFollowers of any task completions.
descriptionstringoptionalThe description of the task. Support for plain text and Markdown formatting.
due_datestringoptionalThe due date of the task. If omitted, falls back to the milestone due date when one is set.
estimated_minutesstringoptionalThe estimated time to complete the task in minutes.
namestringoptionalThe name/title of the task.
parent_task_idstringoptionalThe ID of the parent task if creating a subtask.
predecessorsstringoptionalTask dependencies that must be completed before this task can start.
prioritystringoptionalThe priority of the task.
progressstringoptionalThe progress of the task, as a percentage (0-100). Only whole numbers are allowed.
start_datestringoptionalThe start date of the task.
tag_idsstringoptionalA list of tag IDs to associate with the task.
tasklist_idstringoptionalThe ID of the tasklist.

Tool: twprojects-update_tasklist

Update tasklist.

ParametersTypeDescription
idintegerThe ID of the tasklist to update.
descriptionstringoptionalThe description of the tasklist.
milestone_idstringoptionalThe ID of the milestone to associate with the tasklist.
namestringoptionalThe name of the tasklist.

Tool: twprojects-update_team

Update team.

ParametersTypeDescription
idintegerThe ID of the team to update.
company_idstringoptionalThe ID of the company. This is used to create a team scoped for a specific company.
descriptionstringoptionalThe description of the team.
handlestringoptionalThe handle of the team. It is a unique identifier for the team. It must not have spaces or special characters.
namestringoptionalThe name of the team.
parent_team_idstringoptionalThe ID of the parent team. This is used to create a hierarchy of teams.
project_idstringoptionalThe ID of the project. This is used to create a team scoped for a specific project.
user_idsstringoptionalUsers to add to the team.

Tool: twprojects-update_timelog

Update timelog.

ParametersTypeDescription
idintegerThe ID of the timelog to update.
billablestringoptionalIf true, the timelog is billable.
datestringoptionalThe date of the timelog.
descriptionstringoptionalA description of the timelog.
hoursstringoptionalThe number of hours spent on the timelog. Must be a positive integer.
is_utcstringoptionalIf true, the time is in UTC.
minutesstringoptionalMinutes spent on the timelog. Must be a positive integer less than 60; otherwise increment hours instead.
project_idstringoptionalProject the timelog is logged against. Provide exactly one of project_id or task_id.
tag_idsstringoptionalA list of tag IDs to associate with the timelog.
task_idstringoptionalTask the timelog is logged against. Provide exactly one of project_id or task_id.
timestringoptionalThe time of the timelog in the format HH:MM:SS.
user_idstringoptionalUser the timelog is logged for. Defaults to the authenticated user.

Tool: twprojects-update_timer

Update timer.

ParametersTypeDescription
idintegerThe ID of the timer to update.
billablestringoptionalIf true, the timer is billable.
descriptionstringoptionalA description of the timer.
project_idstringoptionalThe ID of the project to associate the timer with.
runningstringoptionalIf true, the timer will start running immediately.
task_idstringoptionalThe ID of the task to associate the timer with.

Tool: twprojects-update_user

Update user.

ParametersTypeDescription
idintegerThe ID of the user to update.
adminstringoptionalIndicates whether the user is an administrator.
company_idstringoptionalThe ID of the client/company to which the user belongs.
emailstringoptionalThe email address of the user.
first_namestringoptionalThe first name of the user.
last_namestringoptionalThe last name of the user.
titlestringoptionalThe job title of the user, such as 'Project Manager' or 'Senior Software Developer'.
typestringoptionalThe type of user, such as 'account', 'collaborator', or 'contact'.

Tool: twprojects-update_workflow

Update workflow.

ParametersTypeDescription
idintegerThe ID of the workflow to update.
namestringoptionalThe new name of the workflow.

Tool: twprojects-update_workflow_stage

Update workflow stage.

ParametersTypeDescription
idintegerThe ID of the workflow stage to update.
workflow_idintegerThe ID of the workflow that owns the stage.
namestringoptionalThe new name of the workflow stage.

Tool: twprojects-users_workload

Get task allocation across users for a date range. (workload of users)

ParametersTypeDescription
end_datestringEnd of the workload period.
start_datestringStart of the workload period.
pagestringoptionalPage number for pagination of results.
page_sizestringoptionalNumber of results per page for pagination.
project_idsstringoptionalFilter workload by project.
user_company_idsstringoptionalFilter workload by users' client/company.
user_idsstringoptionalFilter workload by user.
user_team_idsstringoptionalFilter workload by users' team.

This tool is read-only. It does not modify its environment.


Tool: twspaces-create_category

Create space category.

ParametersTypeDescription
namestringThe name of the category.
colorstringoptionalA hex color code for the category (e.g. "#FF5733").

Tool: twspaces-create_comment

Create comment on a page. Use parentId for replies.

ParametersTypeDescription
contentstringThe content of the comment.
pageIdintegerThe ID of the page to comment on.
spaceIdintegerThe ID of the space containing the page.
isPrivatestringoptionalSet to true to create a private comment visible only to space members.
parentIdstringoptionalThe ID of the parent comment (for creating a reply).

Tool: twspaces-create_page

Create page in a space.

ParametersTypeDescription
spaceIdintegerThe ID of the space to create the page in.
titlestringThe title of the page.
changeMessagestringoptionalA message describing the changes made in this version.
contentstringoptionalThe HTML content of the page.
isFullWidthstringoptionalDisplay the page in full-width layout.
isPublishstringoptionalSet to true to publish the page immediately (default: draft).
isRequiredReadingstringoptionalMark this page as required reading for space members.
parentIdstringoptionalThe ID of the parent page (for creating a sub-page).
readerInlineCommentsEnabledstringoptionalAllow readers to add inline comments on this page.
slugstringoptionalA URL-friendly slug for the page.

Tool: twspaces-create_space

Create space.

ParametersTypeDescription
codestringA short unique code/identifier for the space (e.g. "ENG", "DOCS").
titlestringThe title of the space.
categoryIdstringoptionalCategory to assign. Use twspaces-list_categories to discover.
iconstringoptionalAn icon identifier for the space.
projectIdstringoptionalThe ID of a Teamwork project to link to this space.
purposestringoptionalA brief description of the space's purpose.
spaceColorstringoptionalA hex color code for the space (e.g. "#FF5733").

Tool: twspaces-create_tags

Create one or more Spaces tags in a single request.

ParametersTypeDescription
tagsarrayTags to create.

Tool: twspaces-delete_category

Delete space category.

ParametersTypeDescription
idintegerThe ID of the category to delete.

This tool may perform destructive updates.


Tool: twspaces-delete_comment

Delete page comment. Irreversible.

ParametersTypeDescription
commentIdintegerThe ID of the comment to delete.
pageIdintegerThe ID of the page containing the comment.
spaceIdintegerThe ID of the space containing the page.

This tool may perform destructive updates.


Tool: twspaces-delete_page

Delete page. Irreversible.

ParametersTypeDescription
pageIdintegerThe ID of the page to delete.
spaceIdintegerThe ID of the space containing the page.

This tool may perform destructive updates.


Tool: twspaces-delete_space

Delete space. Irreversible; removes all content.

ParametersTypeDescription
idintegerThe ID of the space to delete.

This tool may perform destructive updates.


Tool: twspaces-delete_tag

Delete Spaces tag.

ParametersTypeDescription
idintegerThe ID of the tag to delete.

This tool may perform destructive updates.


Tool: twspaces-duplicate_page

Duplicate page with a new title.

ParametersTypeDescription
pageIdintegerThe ID of the page to duplicate.
spaceIdintegerThe ID of the space containing the page.
titlestringThe title for the duplicated page.
parentIdstringoptionalThe ID of the parent page for the duplicate (defaults to same parent).
slugstringoptionalA URL-friendly slug for the duplicated page.

Tool: twspaces-get_category

Get space category.

ParametersTypeDescription
idintegerThe ID of the category to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twspaces-get_comment

Get page comment.

ParametersTypeDescription
commentIdintegerThe ID of the comment to retrieve.
pageIdintegerThe ID of the page containing the comment.
spaceIdintegerThe ID of the space containing the page.

This tool is read-only. It does not modify its environment.


Tool: twspaces-get_homepage

Get a space's homepage.

ParametersTypeDescription
spaceIdintegerThe ID of the space to retrieve the homepage for.

This tool is read-only. It does not modify its environment.


Tool: twspaces-get_page

Get page. Returns content, metadata, tags, and revision info.

ParametersTypeDescription
pageIdintegerThe ID of the page to retrieve.
spaceIdintegerThe ID of the space containing the page.

This tool is read-only. It does not modify its environment.


Tool: twspaces-get_space

Get space.

ParametersTypeDescription
idintegerThe ID of the space to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twspaces-get_tag

Get Spaces tag.

ParametersTypeDescription
idintegerThe ID of the tag to retrieve.

This tool is read-only. It does not modify its environment.


Tool: twspaces-list_categories

List space categories.

ParametersTypeDescription
pageOffsetstringoptionalThe index position to start retrieving results from (not a page number).
pageSizestringoptionalNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twspaces-list_comments

List comments on a page. Returns top-level comments with replies.

ParametersTypeDescription
pageIdintegerThe ID of the page to list comments for.
spaceIdintegerThe ID of the space containing the page.
pageOffsetstringoptionalThe index position to start retrieving results from (not a page number).
pageSizestringoptionalNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twspaces-list_pages

List pages in a space as a hierarchical tree.

ParametersTypeDescription
spaceIdintegerThe ID of the space to list pages for.
pageOffsetstringoptionalThe index position to start retrieving results from (not a page number).
pageSizestringoptionalNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twspaces-list_space_collaborators

List space collaborators (users and teams).

ParametersTypeDescription
idintegerThe ID of the space to retrieve collaborators for.

This tool is read-only. It does not modify its environment.


Tool: twspaces-list_spaces

List spaces.

ParametersTypeDescription
pageOffsetstringoptionalThe index position to start retrieving results from (not a page number).
pageSizestringoptionalNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twspaces-list_tags

List Spaces tags.

ParametersTypeDescription
pageOffsetstringoptionalThe index position to start retrieving results from (not a page number).
pageSizestringoptionalNumber of results per page for pagination.

This tool is read-only. It does not modify its environment.


Tool: twspaces-search

Full-text search across pages. Filter by space.

ParametersTypeDescription
querystringThe search query string.
includeDeletedstringoptionalInclude deleted pages in search results.
pageOffsetstringoptionalThe index position to start retrieving results from (not a page number).
pageSizestringoptionalNumber of results per page for pagination.
spaceIdsstringoptionalLimit search to specific spaces. Use twspaces-list_spaces to discover.

This tool is read-only. It does not modify its environment.


Tool: twspaces-update_category

Update space category.

ParametersTypeDescription
idintegerThe ID of the category to update.
colorstringoptionalA new hex color code for the category.
namestringoptionalThe new name for the category.

Tool: twspaces-update_comment

Update page comment.

ParametersTypeDescription
commentIdintegerThe ID of the comment to update.
pageIdintegerThe ID of the page containing the comment.
spaceIdintegerThe ID of the space containing the page.
contentstringoptionalThe new content of the comment.
isPrivatestringoptionalChange the privacy setting of the comment.
statestringoptionalThe new state of the comment (e.g. "active", "resolved").

Tool: twspaces-update_page

Update page.

ParametersTypeDescription
pageIdintegerThe ID of the page to update.
spaceIdintegerThe ID of the space containing the page.
changeMessagestringoptionalA message describing the changes made in this version.
contentstringoptionalThe new HTML content of the page.
draftVersionstringoptionalOptimistic concurrency token for the page's draft content. Required when updating content; optional otherwise. Obtain the current value from the draftVersion field with twspaces-get_page or twspaces-list_pages tools.
isFullWidthstringoptionalToggle full-width layout for this page.
isMinorChangestringoptionalMark this update as a minor change (won't notify watchers).
isPublishstringoptionalSet to true to publish the page, false to revert to draft.
isRequiredReadingstringoptionalMark or unmark this page as required reading.
parentIdstringoptionalThe ID of the new parent page (to move the page).
readerInlineCommentsEnabledstringoptionalAllow or disallow readers from adding inline comments.
slugstringoptionalA new URL-friendly slug for the page.
titlestringoptionalThe new title of the page.

Tool: twspaces-update_space

Update space.

ParametersTypeDescription
idintegerThe ID of the space to update.
categoryIdstringoptionalCategory to assign. Use twspaces-list_categories to discover.
codestringoptionalA new short unique code/identifier for the space.
iconstringoptionalA new icon identifier for the space.
projectIdstringoptionalThe ID of a Teamwork project to link to this space.
purposestringoptionalA new brief description of the space's purpose.
spaceColorstringoptionalA new hex color code for the space.
statestringoptionalThe state of the space (e.g. "active", "archived").
titlestringoptionalThe new title of the space.

Tool: twspaces-update_tag

Update Spaces tag.

ParametersTypeDescription
idintegerThe ID of the tag to update.
colorstringoptionalA new hex color code for the tag.
namestringoptionalThe new name for the tag.

Use this MCP Server

{
  "mcpServers": {
    "teamwork": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "TW_MCP_BEARER_TOKEN",
        "mcp/teamwork"
      ],
      "env": {
        "TW_MCP_BEARER_TOKEN": "<TW_MCP_BEARER_TOKEN>"
      }
    }
  }
}

Why is it safer to run MCP Servers with Docker?

Related servers