Docs: Tool reference
core toolset

get_filter_guide

Get the filter guide. Returns the filter DSL reference as Markdown: the shape of conditions and all/any/not groups, every post and user field with its operators and allowed values, and an example. Read it before writing a filter for search_posts, save_view, add_to_roadmap, bulk_update_posts or save_segment. Also available as the carechannel://docs/filter-dsl resource. No side effects.

Toolset
core
Who can call it
OwnersManagersContributorsCustomersAPI keysVisitors
REST
GET /api/v1/w/{workspace}/filter-guide
Behavior
read-onlyidempotent

Input

No input.

Output

FieldTypeDescription
markdownrequiredstringThe guide, in Markdown.

Calling it

// MCP: tools/call
{ "name": "get_filter_guide", "arguments": {} }

// Typed client
await carechannel.get_filter_guide({});