docs: List Posts settings field + postsListTool

[giladresisi]

Docs for the List Posts changes. Complementary to postiz-app #1751 (feat/list-posts-tool).

Changes

• public-api/openapi.json — add a settings field (free-form object) to the Post schema, so GET /public/v1/posts documents the provider settings now returned on every post. Additive and backward-compatible.
• mcp/introduction.mdx — add postsListTool to the Available Tools table; bump the tool count to 10.
• mcp/tools.mdx — add a ## postsListTool reference section.

Tool-count coordination

The sibling docs PR (Update Post Settings) also adds one tool. These are stacked, so on this branch alone the count is 10; the stacked PR bumps it to 11. If the branches land independently, whoever merges second should reconcile the count (and the shared mcp/* files) — a trivial resolution.

Verification

• openapi.json validated as JSON (python3 -m json.tool).
• Rendered locally with Mintlify (mint dev) — List Posts page and MCP pages render without errors.
• Pages Claude-viewed in-browser and human-viewed.

Related: gitroomhq/postiz-app#1751

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation

  • Updated MCP introduction to reflect 10 available tools.
  • Documented a new tool to list scheduled posts within a UTC start/end window, including an optional filter.
  • Expanded tool documentation to describe returned post details (schedule, status, content, metadata, and provider settings).

• API Updates

  • Added provider-specific settings to the public Post schema, supporting additional properties with example data.

[postiz-contribution]

Contribution-checker quality warning
Heuristic score: 30/100 (low). This is a non-blocking warning surfaced by the project's quality settings.

Heuristics that flagged:

• Excessive inline code references: 13 inline refs (>3)
• AI watermark phrase: Matched: "Generated with Claude Code"
• Commit message too long: Longest: 298 chars

If this is a genuine contribution, please add detail to your PR description and tighten the diff scope before reviewers look at it.

[coderabbitai]

Warning

Review limit reached

@egelhaus, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 271da0b4-d71c-4348-ac97-487c020d23b9

📥 Commits

Reviewing files that changed from the base of the PR and between 1350b06 and d5b17b4.

📒 Files selected for processing (1)

• mcp/tools.mdx

📝 Walkthrough

Walkthrough

The MCP documentation now lists 10 tools and documents postsListTool for querying scheduled posts. The OpenAPI Post schema now includes provider-specific settings.

Changes

MCP and API documentation

Layer / File(s)	Summary
Document postsListTool and Post settings mcp/introduction.mdx, mcp/tools.mdx, public-api/openapi.json	The MCP docs add postsListTool, including date parameters, optional customer filtering, and returned post metadata. The OpenAPI Post schema adds provider-specific settings.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: egelhaus

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title is concise and clearly reflects the main documentation changes: the List Posts settings field and postsListTool.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch feat/list-posts-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[postiz-agent]

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@mcp/tools.mdx`:
- Around line 185-186: Update the startDate and endDate examples in the
parameter documentation to include an explicit UTC timezone suffix, using the
requested Z-qualified timestamps while leaving the descriptions unchanged.
- Around line 179-203: Update the postsListTool documentation to match the
public API contract: document the nested integration object instead of flattened
integrationId, platform, and integrationName fields, or explicitly describe the
MCP transformation if the flattened response is intentional. Ensure the “same
data as the List Posts API” statement remains only if the documented response
shape accurately reflects that API.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4d167069-5890-42d2-a8b3-6df424e37fce

📥 Commits

Reviewing files that changed from the base of the PR and between f31409f and 3286aa5.

📒 Files selected for processing (3)

• mcp/introduction.mdx
• mcp/tools.mdx
• public-api/openapi.json