Skip to content

docs(TSP-1437): document Slack Send Message outputs and Update Message tool step - #809

Open
claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1437
Open

claude[bot] wants to merge 1 commit into
mainfrom
docs/TSP-1437

Conversation

@claude

@claude claude Bot commented Sep 9, 2026

Copy link
Copy Markdown

Summary

  • Send Message outputs: Documents the two new values returned after sending a Slack message — ts (message timestamp) and channel (channel ID) — and explains how to wire them into a subsequent Update Message step.
  • Update Message tool step: New page documenting the Slack: Update Message tool step, covering the required channel and ts inputs, the optional text, blocks (Block Kit JSON array), and attachments inputs, and the rule that at least one content field must be provided.
  • Progress checklist example: Both pages include an accordion example showing ⬜→✅ checklist updates via in-place message edits.
  • Navigation + snippet: Added update-message to docs.json and the slack-tool-steps snippet.

Test plan

  • Verify build/tools/tool-steps/slack/send-message renders the new Outputs section and accordion correctly
  • Verify build/tools/tool-steps/slack/update-message renders inputs tables and accordion correctly
  • Confirm the Update Message page appears in the sidebar under "Slack Tool Steps"
  • Confirm the snippet card for Update Message appears on the Slack integration page
  • Check all internal links resolve (/build/tools/tool-steps/slack/update-message, /integrations/popular-integrations/slack)

Linear: https://linear.app/relevance/issue/TSP-1437/

🤖 Generated with Claude Code

…ssage tool step

- Add Outputs section to Send Message page: ts (timestamp) and channel (ID) returned after sending
- Create Update Message tool step page documenting channel/ts inputs, optional text/blocks/attachments, and Block Kit support
- Add progress-checklist example showing how to wire ts+channel into Update Message to edit a message in place
- Register update-message in docs.json navigation and slack-tool-steps snippet

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@claude claude Bot added the docs-drafter Documentation drafted by Claude label Sep 9, 2026
@mintlify

mintlify Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
relevanceai 🟢 Ready View Preview Sep 9, 2026, 7:04 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@linear

linear Bot commented Sep 9, 2026

Copy link
Copy Markdown

TSP-1437

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

🎯 Vibe check

Reviewed: 4 files (3 MDX + docs.json; 3 with issues, 1 navigation-only)

Scores

Dimension Score What's holding it back
🟡 Consistency 7/10 Non-descriptive [here] link text in both MDX files; iframe title copy-pasted from another page
🟡 Technical clarity 7/10 Supademo embed in send-message.mdx reuses the same URL as the Slack integration setup demo — needs verification; content-input table in update-message.mdx marks all three fields as No while the prose says at least one is required
🟢 Non-technical clarity 9/10 No issues found. The progress-checklist example is concrete and immediately actionable.
🟡 Structure 7/10 Both accordions use bullet lists with bold section headers, which CLAUDE.md explicitly disallows in accordion content; numbered procedures could use <Steps>

Score key: 🟢 9–10, 🟡 6–8, 🔴 1–5.

Overall vibe: The PR adds genuinely useful reference content — the ts/channel output table is clean, the cross-linking between Send and Update is clear, and the example pattern is concrete and practical. The main friction is style-compliance: accordion content is formatted as nested bullets + bold labels when the guidelines call for flowing prose, and a couple of copy-paste residuals need cleaning up.

🔧 Issues (5)
  • build/tools/tool-steps/slack/send-message.mdx:9[here] is non-descriptive link text. Change to something like [the Slack integration page](/integrations/popular-integrations/slack). Same pattern in the identical Note on update-message.mdx:9.

  • build/tools/tool-steps/slack/update-message.mdx:9 — same [here] link text issue as above.

  • build/tools/tool-steps/slack/send-message.mdx:16 — iframe title attribute reads "Add the Python Tool step to your Tool". This is a copy-paste residual from a different page; update it to describe the Slack Send Message demo.

  • build/tools/tool-steps/slack/send-message.mdx:16 — The supademo embed ID cmb77dn944hpdppkpmiavfbmi is the same URL used on integrations/popular-integrations/slack.mdx for the Slack integration setup flow ("Add Integration"), not a Tool step demo. Verify this embed actually shows the Send Message tool step; if not, swap in the correct demo URL.

  • build/tools/tool-steps/slack/update-message.mdx:24-28 — The three content-input fields (text, blocks, attachments) all show Required: No, but the preceding sentence says "at least one of the following must be provided." Consider adding a * or footnote (e.g. "at least one required") or a column note so the table is self-consistent without needing the surrounding prose.

🧩 Component suggestions (3)
  • build/tools/tool-steps/slack/send-message.mdx:39–55 — The accordion uses bullet lists with bold subsection headers (**Send Message step**, **Update Message step**). CLAUDE.md says accordion content should use flowing sentences, not bullet lists. Rewrite as prose, e.g.: "The Send Message step posts the initial checklist (Task progress:\n⬜ Step 1…) and exposes ts and channel outputs. Each subsequent Update Message step takes those outputs as inputs and overwrites the message content — first marking Step 1 complete, then Step 2, keeping a single message in the channel rather than a chain of replies."

  • build/tools/tool-steps/slack/update-message.mdx:43–61 — Same issue: accordion content is structured as bullet lists with bold headers. Rewrite as a flowing prose paragraph describing the same three-step pattern.

  • build/tools/tool-steps/slack/send-message.mdx:20–26 and update-message.mdx:32–37 — Both "Add the step to your Tool" sections use plain numbered lists for sequential procedures. These are a natural fit for <Steps>, which adds visual progress indicators. The sibling page retrieve-messages.mdx also uses a plain numbered list, so this is a consistent existing pattern — flag for the team to decide if they want to adopt <Steps> across all three pages at once rather than introducing inconsistency.

⚠️ Contradictions (1)
  • build/tools/tool-steps/slack/send-message.mdx:16 and integrations/popular-integrations/slack.mdx:22 — Both embed the same supademo URL (cmb77dn944hpdppkpmiavfbmi). The integration page captions it as the "Add Integration" OAuth setup flow; send-message.mdx uses it to demonstrate adding a Tool step. If they genuinely show the same recording, one of the two pages is misleading readers about what they're watching.
✅ Clean files (1)

docs.json — navigation update correctly slots update-message between send-message and retrieve-messages. No issues.

🔋 Credit usage
Item Count
Files reviewed 4
Context pages read 2
Total lines processed ~473

Files read: _snippets/components/integrations/slack-tool-steps.mdx (11 lines), build/tools/tool-steps/slack/send-message.mdx (55 lines), build/tools/tool-steps/slack/update-message.mdx (61 lines), build/tools/tool-steps/slack/retrieve-messages.mdx (26 lines), integrations/popular-integrations/slack.mdx (320 lines)

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

Labels

docs-drafter Documentation drafted by Claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant