Skip to content

Commit b4a01e1

Browse files
committed
docs(CHANGES) link models and middleware via {class}/{attr} cross-refs
SearchPanesResult, PaneContentMatch, SessionInfo.active_pane_id, and the four project-local middleware classes (AuditMiddleware, SafetyMiddleware, ReadonlyRetryMiddleware, TailPreservingResponseLimitingMiddleware) now resolve to the API reference pages instead of rendering as bare code. TimingMiddleware and ErrorHandlingMiddleware stay bare — they come from fastmcp and the project has no intersphinx inventory for it.
1 parent 6ef25f1 commit b4a01e1

1 file changed

Lines changed: 22 additions & 16 deletions

File tree

CHANGES

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,16 @@ _FastMCP alignment: new tools, prompts, and middleware (#15)_
1010

1111
### Breaking changes
1212

13-
- {tooliconl}`search-panes` now returns `SearchPanesResult` instead of
14-
`list[PaneContentMatch]`. Matches moved to `.matches`; new
15-
`truncated`, `truncated_panes`, `total_panes_matched`, `offset`,
16-
`limit` fields enable pagination. Migrate
17-
`for m in search_panes(...)` → `for m in search_panes(...).matches`.
13+
- {tooliconl}`search-panes` now returns
14+
{class}`~libtmux_mcp.models.SearchPanesResult` instead of
15+
`list[`{class}`~libtmux_mcp.models.PaneContentMatch``]`. Matches
16+
moved to `.matches`; new `truncated`, `truncated_panes`,
17+
`total_panes_matched`, `offset`, `limit` fields enable pagination.
18+
Migrate `for m in search_panes(...)` →
19+
`for m in search_panes(...).matches`.
1820
- Minimum `fastmcp>=3.2.4` (was `>=3.1.0`). Required for
19-
`ReadonlyRetryMiddleware` and per-parameter input-schema
20-
descriptions.
21+
{class}`~libtmux_mcp.middleware.ReadonlyRetryMiddleware` and
22+
per-parameter input-schema descriptions.
2123

2224
### What's new
2325

@@ -49,13 +51,17 @@ _FastMCP alignment: new tools, prompts, and middleware (#15)_
4951

5052
**Middleware stack**
5153

52-
- `TimingMiddleware`, `ErrorHandlingMiddleware`, `AuditMiddleware`
53-
(digest-redacted argument summaries), `SafetyMiddleware` (tier-gated
54-
tool visibility), `ReadonlyRetryMiddleware` (transparent retry of
55-
readonly tools on transient {exc}`libtmux.exc.LibTmuxException`;
56-
mutating tools never retry),
57-
`TailPreservingResponseLimitingMiddleware` (trims oversized output
58-
from the head so the active prompt survives).
54+
- `TimingMiddleware`, `ErrorHandlingMiddleware`,
55+
{class}`~libtmux_mcp.middleware.AuditMiddleware` (digest-redacted
56+
argument summaries),
57+
{class}`~libtmux_mcp.middleware.SafetyMiddleware` (tier-gated tool
58+
visibility),
59+
{class}`~libtmux_mcp.middleware.ReadonlyRetryMiddleware`
60+
(transparent retry of readonly tools on transient
61+
{exc}`libtmux.exc.LibTmuxException`; mutating tools never retry),
62+
{class}`~libtmux_mcp.middleware.TailPreservingResponseLimitingMiddleware`
63+
(trims oversized output from the head so the active prompt
64+
survives).
5965

6066
**Bounded outputs**
6167

@@ -71,8 +77,8 @@ _FastMCP alignment: new tools, prompts, and middleware (#15)_
7177
auto-extracted from NumPy-style docstrings.
7278
- Lifespan startup probe fails fast with {exc}`RuntimeError` if
7379
`tmux` is missing on `PATH`.
74-
- `SessionInfo.active_pane_id` surfaces the pane id returned by
75-
{tooliconl}`create-session`.
80+
- {attr}`~libtmux_mcp.models.SessionInfo.active_pane_id` surfaces the
81+
pane id returned by {tooliconl}`create-session`.
7682

7783
### Fixes
7884

0 commit comments

Comments
 (0)