Skip to content

docs(mcp): add deletePostTool - #251

Open
giladresisi wants to merge 1 commit into
mainfrom
docs/delete-post-tool
Open

giladresisi wants to merge 1 commit into
mainfrom
docs/delete-post-tool

Conversation

@giladresisi

Copy link
Copy Markdown
Collaborator

⚠️ DO NOT MERGE until gitroomhq/postiz-app#2110 is deployed

deletePostTool only exists once that backend change is live. Merging earlier would document a tool production does not expose.

What kind of change does this PR introduce?

Documentation (MCP section). Adds a ## deletePostTool section to mcp/tools.mdx after postSettingsTool (description, id parameter, id return value, { errors } failure shape, link to the public API Delete Post page) and a deletePostTool row to the tools table in mcp/introduction.mdx. Nothing else on either page changed.

Why was this change needed?

The public API and the CLI could delete a post but the agent and the MCP server could not, so users who asked their assistant to cancel posts had to delete them by hand in the calendar. gitroomhq/postiz-app#2110 adds deletePostTool with the same semantics as DELETE /posts/:id. The docs spell out the two things a user is most likely to misread: a post scheduled to several channels is a separate post per channel (deleting one leaves the others), and a published post is only removed from Postiz, not from the social network.

QA

  1. Run npx mint dev in the repo and open /mcp/tools#deleteposttool
  2. The section appears after postSettingsTool, is listed in the "On this page" sidebar, and its "Delete Post" link opens /public-api/posts/delete
  3. Parameters has one id row (string, Required "Yes"), Returns has one id row, followed by the { errors: string } sentence
  4. Open /mcp/introduction: the Available Tools table has a deletePostTool row after postSettingsTool
  5. No table overflows the content column and neither page has horizontal scroll

Checked this way locally with Mintlify in Chrome at 1470px: both pages render correctly, the link resolves (200), the new tables sit inside the content column like the neighbouring ones.

Related

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@postiz-contribution postiz-contribution Bot added the contribution:approved Approved contributor label Sep 21, 2026
@coderabbitai

coderabbitai Bot commented Sep 21, 2026

Copy link
Copy Markdown

Warning

Review limit reached

Next included review available in 59 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 25a7873f-8022-4d53-b776-22adf765edb6

📥 Commits

Reviewing files that changed from the base of the PR and between e37f371 and 1950a8f.

📒 Files selected for processing (2)
  • mcp/introduction.mdx
  • mcp/tools.mdx

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

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

@postiz-agent

postiz-agent Bot commented Sep 21, 2026

Copy link
Copy Markdown

✅ 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.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution:approved Approved contributor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant