Docs: Tool reference

Tool reference

Every operation, by toolset. Each is an MCP tool and a REST route with the same name, input and output.

core

Browse, search, submit, vote, comment, and read the roadmap and changelog

ToolWhat it doesWho can call it
whoamiShow who I amOwnersManagersContributorsCustomersAPI keys
get_workspace_overviewGet the workspace overviewOwnersManagersContributorsCustomersAPI keysVisitors
get_filter_guideGet the filter guideOwnersManagersContributorsCustomersAPI keysVisitors
list_boardsList boardsOwnersManagersContributorsCustomersAPI keysVisitors
search_postsSearch postsOwnersManagersContributorsCustomersAPI keysVisitors
count_postsCount postsOwnersManagersContributorsCustomersAPI keysVisitors
list_my_activityList my ideasCustomers
get_postGet a postOwnersManagersContributorsCustomersAPI keysVisitors
find_similar_postsFind similar postsOwnersManagersContributorsCustomersAPI keysVisitors
create_postCreate a postOwnersManagersContributorsCustomersAPI keys
update_postEdit a postOwnersManagersContributorsCustomersAPI keys
delete_postDelete a postOwnersManagersContributorsCustomersAPI keys
create_uploadStart a file uploadOwnersManagersContributorsCustomersAPI keys
vote_postVote for a postCustomers
unvote_postRemove your voteCustomers
list_commentsList a post's commentsOwnersManagersContributorsCustomersAPI keysVisitors
create_commentComment on a postOwnersManagersContributorsCustomersAPI keys
update_commentEdit a commentOwnersManagersContributorsCustomersAPI keys
delete_commentDelete a commentOwnersManagersContributorsCustomersAPI keys
restore_postRestore a deleted postOwnersManagersContributorsCustomersAPI keys
list_notificationsList your notificationsOwnersManagersContributorsCustomers
mark_notifications_readMark notifications readOwnersManagersContributorsCustomers
get_notification_preferencesGet your notification settingsOwnersManagersContributors
save_notification_preferencesChange your notification settingsOwnersManagersContributors
followFollow a post, board or categoryOwnersManagersContributorsCustomers
unfollowUnfollow a post, board or categoryOwnersManagersContributorsCustomers
get_email_preferencesGet your email settingsCustomers
save_email_preferencesChange your email settingsCustomers
get_public_roadmapGet the public roadmapOwnersManagersContributorsCustomersAPI keysVisitors
list_changelog_entriesList changelog entriesOwnersManagersContributorsCustomersAPI keysVisitors
get_changelog_entryGet a changelog entryOwnersManagersContributorsCustomersAPI keysVisitors
subscribe_changelogSubscribe to the changelogCustomers
unsubscribe_changelogUnsubscribe from the changelogCustomers
get_shared_roadmapOpen a shared roadmapOwnersManagersContributorsCustomersAPI keysVisitors

triage

Change status, owners and tags, merge posts, moderate, edit in bulk, and vote on behalf of customers

ToolWhat it doesWho can call it
list_votersList a post's votersOwnersManagersContributorsAPI keys
change_post_statusChange a post's statusOwnersManagersAPI keys
list_moderation_queueList posts awaiting reviewOwnersManagersAPI keys
moderate_postApprove or reject a postOwnersManagersAPI keys
assign_post_ownerAssign a post's ownerOwnersManagersAPI keys
set_post_etaSet a post's ETAOwnersManagersAPI keys
add_post_tagsTag a postOwnersManagersContributorsAPI keys
remove_post_tagsUntag a postOwnersManagersContributorsAPI keys
move_postMove a post to another boardOwnersManagersAPI keys
merge_postsMerge duplicate postsOwnersManagersAPI keys
unmerge_postUnmerge a postOwnersManagersAPI keys
bulk_update_postsUpdate many posts at onceOwnersManagersAPI keys
add_vote_on_behalfVote for a customerOwnersManagersContributorsAPI keys
set_vote_prioritySet a vote's priority or noteOwnersManagersContributorsAPI keys
remove_voteRemove a customer's voteOwnersManagersAPI keys

customers

Read and edit users, companies and segments

ToolWhat it doesWho can call it
block_userBlock an end userOwnersManagersAPI keys
unblock_userUnblock an end userOwnersManagersAPI keys
search_usersSearch customersOwnersManagersContributorsAPI keys
get_userGet a customerOwnersManagersContributorsAPI keys
save_userCreate or update a customerOwnersManagersContributorsAPI keys
merge_usersMerge duplicate customersOwnersManagersAPI keys
delete_userDelete a customer and their contentOwnersManagersAPI keys
export_user_dataExport a customer's dataOwnersManagersAPI keys
search_companiesSearch companiesOwnersManagersContributorsAPI keys
get_companyGet a companyOwnersManagersContributorsAPI keys
save_companyCreate or update a companyOwnersManagersContributorsAPI keys
link_user_companyAdd a customer to a companyOwnersManagersContributorsAPI keys
unlink_user_companyRemove a customer from a companyOwnersManagersAPI keys
list_segmentsList segmentsOwnersManagersContributorsAPI keys
preview_segmentPreview who is in a segmentOwnersManagersContributorsAPI keys
save_segmentCreate or update a segmentOwnersManagersAPI keys
delete_segmentDelete a segmentOwnersManagersAPI keys

planning

Roadmaps, scoring, saved views, reports and exports

ToolWhat it doesWho can call it
list_viewsList saved viewsOwnersManagersContributorsAPI keys
run_viewRun a saved viewOwnersManagersContributorsAPI keys
save_viewCreate or update a saved viewOwnersManagersContributorsAPI keys
delete_viewDelete a saved viewOwnersManagersContributorsAPI keys
export_dataExport a CSVOwnersManagersAPI keys
get_exportCheck an exportOwnersManagersAPI keys
list_roadmapsList roadmapsOwnersManagersContributorsAPI keys
get_roadmapGet a roadmapOwnersManagersContributorsAPI keys
save_roadmapCreate or update a roadmapOwnersManagersAPI keys
delete_roadmapDelete a roadmapOwnersManagersAPI keys
add_to_roadmapAdd posts to a roadmapOwnersManagersAPI keys
remove_from_roadmapRemove posts from a roadmapOwnersManagersAPI keys
configure_scoringConfigure roadmap scoringOwnersManagersAPI keys
set_factor_valuesSet manual factor valuesOwnersManagersAPI keys
rank_roadmap_postRank a post on a roadmapOwnersManagersAPI keys
get_reportGet a reportOwnersManagersContributorsAPI keys
create_share_linkShare a roadmap viewOwnersManagersAPI keys
list_share_linksList share linksOwnersManagersAPI keys
revoke_share_linkRevoke a share linkOwnersManagersAPI keys

changelog

Draft and publish changelog entries

ToolWhat it doesWho can call it
save_changelog_entrySave a changelog entryOwnersManagersContributorsAPI keys
publish_changelog_entryPublish a changelog entryOwnersManagersAPI keys
unpublish_changelog_entryUnpublish a changelog entryOwnersManagersAPI keys
delete_changelog_entryDelete a changelog entryOwnersManagersAPI keys
list_changelog_labelsList changelog labelsOwnersManagersContributorsAPI keys
save_changelog_labelSave a changelog labelOwnersManagersAPI keys
delete_changelog_labelDelete a changelog labelOwnersManagersAPI keys
list_changelog_subscribersList changelog subscribersOwnersManagersAPI keys

admin

Boards, categories, tags, statuses, custom fields, members and settings

ToolWhat it doesWho can call it
list_membersList membersOwners
invite_memberInvite a memberOwners
resend_invitationResend an invitationOwners
revoke_invitationRevoke an invitationOwners
update_member_roleChange a member's roleOwners
remove_memberRemove a memberOwners
save_boardSave a boardOwnersManagersAPI keys
delete_boardDelete a boardOwnersManagersAPI keys
save_categorySave a categoryOwnersManagersAPI keys
delete_categoryDelete a categoryOwnersManagersAPI keys
save_statusSave a statusOwnersManagersAPI keys
reorder_statusesReorder statusesOwnersManagersAPI keys
delete_statusDelete a statusOwnersManagersAPI keys
save_tagSave a tagOwnersManagersAPI keys
delete_tagDelete a tagOwnersManagersAPI keys
list_custom_fieldsList custom fieldsOwnersManagersContributorsAPI keys
save_custom_fieldCreate or update a custom fieldOwnersManagersAPI keys
delete_custom_fieldDelete a custom fieldOwnersManagersAPI keys
get_workspace_settingsGet workspace settingsOwnersManagersContributorsAPI keys
update_workspace_settingsUpdate workspace settingsOwners
check_custom_domainCheck the custom domainOwners
get_setup_checklistGet the setup checklistOwnersManagersContributorsAPI keys
update_setup_checklistUpdate the setup checklistOwners

audit

Read the audit log and undo actions

ToolWhat it doesWho can call it
list_audit_eventsList audit eventsOwnersManagersContributorsAPI keys
get_usageGet usage and performanceOwners
undo_actionUndo an actionOwnersManagersContributorsAPI keys