Handle custom ticket statuses: list_ticket_statuses tool + unresolved shortcut

The pesco instance defines 13 ticket statuses, not the 4 defaults, so a
(status:2 OR status:3) 'open tickets' filter silently dropped Working,
Scheduled, Waiting*, Pending Approval, etc. — undercounting 24 open tickets as 1.

Add a status helper that reads the status field from /ticket_form_fields and
treats only ids 4/5 (and closed/resolved-labelled) as terminal. Expose
list_ticket_statuses() and a list_tickets(unresolved=True) shortcut that builds
the full non-terminal status clause automatically. Document the gotcha in the
skill reference.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
2026-06-16 21:36:25 -06:00
parent 61c0b39e06
commit 0b6747812f
2 changed files with 75 additions and 17 deletions

View File

@@ -120,34 +120,71 @@ def _coerce_priority(v: Any) -> Any:
return v
# Freshservice instances can define many custom statuses beyond the 4 defaults.
# Resolved and Closed are always system ids 4 and 5; everything else (including
# custom statuses like "Working" or "Waiting Vendor Support") is "open".
_status_cache: dict[str, Any] = {"choices": None}
def _status_choices() -> list[dict[str, Any]]:
"""Fetch (and cache) the instance's ticket status choices via the status
field on /ticket_form_fields."""
if _status_cache["choices"] is None:
res = _request("GET", "/ticket_form_fields")
choices: list[dict[str, Any]] = []
if res.get("ok"):
for f in res["data"].get("ticket_fields", []):
if f.get("name") == "status" or f.get("field_type") == "default_status":
choices = f.get("choices", [])
break
_status_cache["choices"] = choices
return _status_cache["choices"]
def _is_terminal(choice: dict[str, Any]) -> bool:
"""A status counts as terminal (resolved/closed) if it's system id 4/5 or its
label says so (covers custom 'Closed - …' statuses)."""
label = str(choice.get("value", "")).lower()
return choice.get("id") in (4, 5) or "resolved" in label or "closed" in label
def _open_status_ids() -> list[int]:
return [c["id"] for c in _status_choices() if c.get("id") is not None and not _is_terminal(c)]
# --- Tickets ---------------------------------------------------------------
@mcp.tool()
def list_tickets(query: str | None = None, updated_since: str | None = None,
def list_tickets(query: str | None = None, unresolved: bool = False,
updated_since: str | None = None,
order_by: str | None = None, order_type: str | None = None,
workspace_id: int | None = None,
page: int = 1, per_page: int = 30) -> str:
"""List or filter tickets. With `query`, uses the /tickets/filter endpoint.
"""List or filter tickets. With `query` (or `unresolved`), uses /tickets/filter.
Status codes: 2=Open 3=Pending 4=Resolved 5=Closed.
Priority codes: 1=Low 2=Medium 3=High 4=Urgent.
Default status codes: 2=Open 3=Pending 4=Resolved 5=Closed — but this instance
may define CUSTOM statuses too (e.g. "Working", "Waiting Vendor Support"). Call
list_ticket_statuses() to see them all. Priority: 1=Low 2=Medium 3=High 4=Urgent.
Building a filter `query`:
* Filter by ASSIGNEE with the numeric `agent_id`, NOT an email. To go from
an email to the id, call list_agents(email=...) first and read `id`.
* "Open / unresolved / not closed" has no negation operator — enumerate the
statuses instead: `(status:2 OR status:3)`. Wrap an OR group in
parentheses when combining with AND.
* Quote string values: `tag:'vip'`. Dates: `created_at:>'2026-01-01'`.
`unresolved=True`: the turnkey "still-open" filter. The server fetches every
status, drops Resolved/Closed (and any custom closed-like status), and builds
the `(status:.. OR ..)` clause for you — so you don't miss custom statuses.
Combine it with a `query` to scope further (they are AND-ed), e.g.
list_tickets(query="agent_id:21000816864", unresolved=True) = my open tickets.
Examples:
* Tickets assigned to agent 21000816864 that are still open:
"agent_id:21000816864 AND (status:2 OR status:3)"
* Open high-priority: "status:2 AND priority:3"
* Unassigned & open: "agent_id:0 AND status:2"
Building a `query` by hand:
* Filter by ASSIGNEE with the numeric `agent_id`, NOT an email — resolve via
list_agents(email=...) first and read `id`.
* There is no negation operator; prefer `unresolved=True` over hand-listing
statuses. Quote strings: `tag:'vip'`. Dates: `created_at:>'2026-01-01'`.
`workspace_id`: accounts with multiple workspaces only search one workspace by
default. Pass a workspace id to target another (see an agent's workspace_ids).
"""
if unresolved:
ids = _open_status_ids()
if ids:
clause = "(" + " OR ".join(f"status:{i}" for i in ids) + ")"
query = f"({query}) AND {clause}" if query else clause
if query:
params = {"query": f'"{query}"', "workspace_id": workspace_id,
"page": page, "per_page": min(per_page, 100)}
@@ -158,6 +195,17 @@ def list_tickets(query: str | None = None, updated_since: str | None = None,
return _out(_request("GET", "/tickets", params=params))
@mcp.tool()
def list_ticket_statuses() -> str:
"""List every ticket status defined in this Freshservice instance (defaults +
custom), each flagged `terminal` (Resolved/Closed) or open. Use this to build
status filters correctly, or just call list_tickets(unresolved=True)."""
statuses = [{"id": c.get("id"), "label": c.get("value"),
"terminal": _is_terminal(c)} for c in _status_choices()]
return _out({"ok": True, "statuses": statuses,
"open_ids": _open_status_ids()})
@mcp.tool()
def get_ticket(ticket_id: int, include: str | None = None) -> str:
"""Get a ticket by id. `include` e.g. "conversations,requester,stats"."""