Docs: Tool reference
planning toolset

get_roadmap

Get a roadmap. Gets an internal roadmap: its scoring factors and formula, and its posts ranked by score with each factor's raw and normalized value, impact, effort and MRR at stake. Filter with the post DSL, sort, group by status, owner, category, board or tag, or apply a saved roadmap view. Scores refresh within a minute of votes or MRR changing. Team only. No side effects.

Toolset
planning
Who can call it
OwnersManagersContributorsAPI keys
REST
POST /api/v1/w/{workspace}/roadmaps/{roadmap}/query
Behavior
read-onlyidempotent

Input

FieldTypeDescription
roadmaprequiredstringThe roadmap's name or ID (rdm_…).
viewstringA saved roadmap view (name or ID): its filter, sort and grouping apply.
filterobjectOnly items matching this post filter (DSL, as in search_posts).
sortone of: score, impact, effort, votes, created, added, manualscore (default), impact, effort (lowest first), votes, created, added, or manual (the team's own order, set with rank_roadmap_post).
group_byone of: status, owner, category, board, tagGroup items by status, owner, category, board or tag (a post with several tags appears under each). Grouped results aren't paged: each group lists up to limit items.
limitintegerItems per page (or per group), max 200. Default: 50.
cursorstringPass the previous response's next_cursor to get the next page.

Output

FieldTypeDescription
roadmaprequiredobject
totalrequiredintegerItems matching the filter.
sortrequiredone of: score, impact, effort, votes, created, added, manual
group_byrequiredone of: status, owner, category, board, tag or null
itemsrequiredarray of objectThe page of items (empty when grouped).
groupsrequiredarray of object or null
next_cursorrequiredstring or nullCursor for the next page, or null when this is the last page.

Calling it

// MCP: tools/call
{ "name": "get_roadmap", "arguments": {"roadmap":"<string>"} }

// Typed client
await carechannel.get_roadmap({"roadmap":"<string>"});