Skip to content

docs: Document the message_promptless_support MCP tool and tighten the MCP page - #1124

Open
promptless[bot] wants to merge 13 commits into
mainfrom
promptless/mcp-message-promptless-support
Open

promptless[bot] wants to merge 13 commits into
mainfrom
promptless/mcp-message-promptless-support

Conversation

@promptless

@promptless promptless Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Open in Promptless

Proposed changes

Promptless/promptless#5422 added a message_promptless_support MCP tool on both server URLs. Signed-in organization members can now report a problem to the Promptless team from their editor. This change documents the tool and, at a reviewer's request, rewrites the MCP page so it's shorter and leads with why someone would use it.

  • connect/triggers/mcp.mdx: rewritten, about half the previous length (roughly 8,000 → 3,900 words; prose outside tables and code roughly 7,000 → 2,200). The page now:
    • Opens with what the MCP server is for: ask Promptless for docs updates from the editor you already work in, and review the result rather than write it. A short list covers the other things you can do from the same conversation.
    • Keeps setup steps per client and the browser authorization steps, with the access note cut to the essentials.
    • Moves the example asks ("Ask your editor") ahead of the reference, as a table that maps each plain-language request to the tool it uses.
    • Adds a summary table of all 12 tools, then keeps each tool's ### section with its argument table and only the behavior a caller needs.
    • Folds the separate "Answer a clarifying question" section into answer_task_question, and the "What a write commits" section into the direct-edit tools.
    • Turns Troubleshooting into a problem → fix table.
    • Adds the ### message_promptless_support section (arguments, report contents, one-way replies) and its troubleshooting rows.
    • Keeps the page slug, every ### `<tool_name>` heading, and the anchors other pages link to (#connect-the-server, #authorize-in-the-browser, #available-tools, #read-and-edit-documentation-directly, #troubleshooting, #answer-a-clarifying-question). The MCP server links to these anchors.
  • reference/getting-help.mdx: adds a From your editor card that links to the new tool.
  • changelog/changelogs/october-2026.mdx: new October 2026 changelog with a short entry announcing the tool.

Review feedback

  • Frances Liu (changelog): the entry over-explained the tool. Applied with light edits: it now follows her proposed wording, and the report-contents and availability details moved to the tool reference section.
  • Frances Liu (whole MCP page): the page read as AI-generated filler; cut the prose by at least half, use plain language, and start with why someone would use Promptless MCP, using the content strategy as a guide. Applied as a full-page rewrite. The opening follows the engineer-owned-docs persona in the content strategy ("approve, don't author"). The rewrite drops repeated explanations and implementation detail that doesn't change what a reader does, and keeps the facts a caller needs.

Checklist

  • Instructions and examples match the current product behavior.
  • Links and image references are valid.
  • Changed pages render correctly.

Validation: npm run build passes, and the built page has every anchor listed above. remark lint (--frail) and manni meta validate pass, and Vale reports no findings on mcp.mdx.

Trigger Events

Merged current main (manni 4.12.2, #1176) and restamped last-updated on the two changed pages for the manni frontmatter check (#1165). npx manni meta validate (manni 4.12.2) passes with 0 errors.

@vercel

vercel Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
promptless-docs Ready Ready Preview Oct 20, 2026 10:11pm UTC

Request Review

Comment thread src/content/docs/docs/for-docs/connect/triggers/mcp.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/mcp.mdx Outdated
Comment thread src/content/docs/docs/for-docs/connect/triggers/mcp.mdx Outdated
Comment thread src/content/changelog/changelogs/october-2026.mdx Outdated
Comment thread src/content/docs/docs/for-docs/reference/getting-help.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/mcp.mdx

**New Features:**

* **Report a problem to Promptless from your editor:** Your MCP client can now report a problem to the Promptless team with the `message_promptless_support` tool. The report includes your organization, your name and email, and your editor's client name. You describe what went wrong and how urgent it is. It's available on both MCP server URLs to every signed-in organization member. See [`message_promptless_support`](/docs/for-docs/connect/triggers/mcp#message_promptless_support).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dashboard comment by frances@gopromptless.ai:

this is an over-explanation. "The promptless MCP has a new tool to send a message to support. it will proactively surface problems to promptless team so that the promptless humans can get on it. you can also use it to report features or bugs"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. I'll cut this changelog entry down to a short, plain summary close to your wording and reply here with the revised text.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I shortened the entry to three sentences close to your wording and changed the heading to "Message Promptless support from your editor." It now reads:

The Promptless MCP server has a new tool, message_promptless_support, that sends a message to the Promptless team. Your editor can use it to flag problems as they come up, so our team can get on them. You can also use it to report bugs or request features.

I wrote "as they come up" instead of "proactively" because the tool asks the user before it sends anything. The tool's section in the MCP guide still describes it only as a way to report problems or get help. Should that section mention feature requests too?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dashboard comment by frances@gopromptless.ai:

src/content/docs/docs/for-docs/connect/triggers/mcp.mdx:157-157 at 7277a1b

this whole entire doc is overly AI-slop. please cut the prose in half (at least). make the language plain and straightforward, start with what the point of the page is, why would someone want to use promptless mcp. you might find some info in content strategy that can hoepfully guide you to write a more ehlpful doc rather than a pile of facts

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it: you want the whole page cut by at least half, in plain language, opening with what Promptless MCP is for and why someone would use it. I'm rewriting it now, using the content strategy guidance, and will reply here when the update is pushed.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rewrote the whole MCP page and it's about half the length it was: about 3,900 words instead of 8,000, with less than a third of the old prose outside tables and code. It now opens with why someone would use Promptless MCP: ask for docs updates from the editor you're already in, then review the change. That framing comes from the engineer-owned-docs persona in the content strategy. Example requests now come before the tool reference. Each tool has a short section with its arguments and only the behavior a caller needs, and troubleshooting is a problem-and-fix table. I kept the page URL and tool headings unchanged because the MCP server links to them.

Comment thread src/content/docs/docs/for-docs/connect/triggers/mcp.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/mcp.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/mcp.mdx
Comment thread src/content/docs/docs/for-docs/connect/triggers/mcp.mdx
@promptless promptless Bot changed the title docs: Document the message_promptless_support MCP tool docs: Document the message_promptless_support MCP tool and tighten the MCP page Oct 13, 2026
…e-promptless-support

# Conflicts:
#	src/content/changelog/changelogs/october-2026.mdx
…e-promptless-support

# Conflicts:
#	src/content/changelog/changelogs/october-2026.mdx
…e-promptless-support

# Conflicts:
#	src/content/docs/docs/for-docs/connect/triggers/mcp.mdx
@promptless

promptless Bot commented Oct 19, 2026

Copy link
Copy Markdown
Contributor Author

I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed.

promptless Bot and others added 2 commits October 20, 2026 17:45
…e-promptless-support

# Conflicts:
#	src/content/docs/docs/for-docs/connect/triggers/mcp.mdx
#	src/content/docs/docs/for-docs/reference/getting-help.mdx
…e-promptless-support

# Conflicts:
#	src/content/docs/docs/for-docs/connect/triggers/mcp.mdx

This branch was successfully deployed

1 active deployment
Preview — 60e53508 Deployed Oct 20, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant