Sprintree
Sign inGet started

get_preferences

A tool of the Sprintree MCP server. All MCP docs · Back to the tool list

added 2026-10-01

Show your settings: time zone (which decides what "today" and "overdue" mean and when the daily digest arrives), e-mail notification mode (off, instant or daily), the default project view, the web app's theme (light, dark or system), how the web app shows times and dates (time_format, date_format) and which day the week starts on (week_start), the sidebar state and the Display options (board ordering, collapsed columns, sub-tasks, card properties, hierarchy columns) the web app remembers per project. Pass project for one project's options with defaults filled in; without it you get every project you changed. Answers are compact JSON; pass format="text" for a readable Markdown answer.

  • formatenumoptional
    Answer format: "json" (default) is one compact JSON document; "text" is a readable Markdown answer
    jsontext
  • projectstringoptional
    Project key; show the Display options of this project (defaults filled in)

Returns

One of these shapes, depending on the arguments:

Shape 1

  • date_formatanyrequired
    DD.MM.YYYY, YYYY-MM-DD or MMM D, YYYY
  • default_project_viewanyrequired
  • displayobject | nullrequired
    By project key (get_preferences with project fills in defaults)
  • email_availablebooleanrequired
  • email_modestringrequired
    off, instant or daily
  • sidebarobject | nullrequired
    collapsed, openProjectId; null: never changed
  • themestringrequired
    light, dark or system
  • time_formatanyrequired
    24h or 12h
  • time_zonestring | nullrequired
    IANA name; null: not set (UTC)
  • week_startanyrequired
    monday or sunday

Shape 2

    Optional fields, when present

    • planobjectoptional
      Your plan, its limits and what you use (get_preferences only; absent when plans are not enabled)
    • theme_unsetbooleanoptional
      true when no theme was ever set (system is the default)
    • 2026-10-12 — display has collapsedStatuses; showDone is gone.
    • 2026-10-04 — Also returns plan: {name, limits, usage, overridden}, your plan (free or team) with its limits (null = unlimited) and what you use. A full limit refuses with code plan_limit_reached and details {limit, used, max, plan, subject} (used and max only when the limit is yours).
    • 2026-10-01 — Also returns time_format, date_format and week_start, how the web app shows times and dates. Timestamps in tool outputs stay ISO 8601.
    • 2026-10-02 — Answers are compact JSON by default (one document, no Markdown, nothing said twice); format="text" gives the readable Markdown without the json block. The document is the settings themselves.
    • 2026-10-03 — Also answers structuredContent (see outputSchema); a failed call adds structuredContent.error. Text unchanged. Details: /docs/mcp, "Structured results and errors".
    • 2026-10-04 — Claude Code 2.1.288+ (clientInfo claude-code): the text of a successful answer is itself up to 512 bytes, else "Result in structuredContent (N bytes)."; structuredContent and errors are unchanged. See /docs/mcp.
    • 2026-10-04 — format="text" now also answers structuredContent {"text": the Markdown} (it was the JSON document), so a client that reads only structuredContent gets the Markdown it asked for.