Skip to content

docs(chat): integrate Discord adapter into registry and project template - #1485

Open
onlyarnav wants to merge 1 commit into
feat/chat-discord-adapterfrom
docs/chat-discord-integration
Open

onlyarnav wants to merge 1 commit into
feat/chat-discord-adapterfrom
docs/chat-discord-integration

Conversation

@onlyarnav

@onlyarnav onlyarnav commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Part 2 of 2 in the contract:chat Discord adapter stack (preceded by #1484).

Summary

  • Integrates tools/chat-discord into the chat contract documentation (tools/chat/README.md), marking discord as a shipping adapter alongside slack.
  • Documents Discord bot token under $HOME (~/.config/apache-magpie/discord-token or $DISCORD_BOT_TOKEN) in tools/chat/README.md prerequisites credentials.
  • Adds chat.guild_id (commented out by default) and clarifies channel names (with Discord IDs accepted) in plugins/magpie-setup/templates/project.md and tools/chat/README.md.
  • Updates docs/adapters/registry.md chat row to list tools/chat-discord/ as shipping, with Matrix (feat(tools/matrix): chat bridge for projects whose primary chat is Matrix / Element #309) and Zulip (feat(tools/zulip): chat bridge for projects whose primary chat is Zulip #308) tracking links.
  • Updates spec-loop specifications (tools/spec-loop/specs/adapters.md and contributor-growth.md) to reflect Discord as a shipping adapter alongside Slack, noting Matrix and Zulip remain extension points.

Type of change

  • Documentation / process (docs/, README.md, comments)
  • Tool / bridge contract (tools/<system>/*.md)

Test plan

  • Verified links and references across updated documentation and templates.
  • Ran doctoc TOC generation and markdownlint-cli2 across all modified Markdown files.
  • Verified SPDX license headers.
  • Ran spec-validate on tools/spec-loop/specs/.

RFC-AI-0004 compliance

  • Write-access discipline — purely documentation and templates; no code changes.
  • Vendor neutrality — reflects the dual-backend status of contract:chat.
  • External content as data — maintains untrusted data discipline for chat messages across specs and contracts.

Linked issues

Closes #1421

🤖 Generated with Antigravity

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for wiring the Discord adapter from #1484 into the docs — the links to tools/chat-discord/ resolve once #1484 lands, and the stack is in order. Two things need fixing before this merges: a wrong tracking link in the adapter registry (inline), and spec text that now contradicts itself.

The contributor-growth spec now contradicts itself

The specs in tools/spec-loop/specs/ are the source of truth and must not fall behind the code.
— AGENTS.md

In tools/spec-loop/specs/contributor-growth.md the frontmatter source: and the Known-gaps bullet now say chat covers Slack and Discord, but two passages the diff doesn't touch still say otherwise:

  • Where it lives → Tools bullet: `tools/chat-slack` (Slack MCP adapter, public channels only, never posts). Discord is an extension point with no adapter yet.
  • Behaviour & contract → Community signals: chat answers through `contract:chat` (Slack adapter; public channels only).

Please add tools/chat-discord (Discord MCP adapter, public channels only, never posts) to the Tools bullet, drop the "Discord is an extension point" sentence, and change "(Slack adapter; …)" to "(Slack or Discord adapter; …)".

Smaller observations

  • See inline on specs/adapters.md and the project template (chat.guild_id).
  • tools/chat/README.md → Prerequisites → Credentials / auth still describes only the Slack connector; please add a clause for the Discord adapter.
  • The PR description lists docs/labels-and-capabilities.md changes, but those are in #1484 — please correct it so the stack's descriptions match their contents. And consider "Closes #1421" on whichever stack PR lands last, so the adapter issue closes when the work ships.
  • Any change to #1484's coverage (see the review there) flows into the "shipping" wording here.

This review was drafted by an AI-assisted tool and
confirmed by an Apache Magpie maintainer. After you've
addressed the points above and pushed an update, an Apache Magpie
maintainer — a real person — will take the next look
at the PR. The findings cite the project's review criteria;
if you think one of them is mis-applied, please reply on the
PR and a maintainer will weigh in.

More on how Apache Magpie handles maintainer review:
CONTRIBUTING.md.

Comment thread docs/adapters/registry.md Outdated
Comment thread tools/spec-loop/specs/adapters.md Outdated
Comment thread plugins/magpie-setup/templates/project.md Outdated
onlyarnav added a commit that referenced this pull request Oct 4, 2026
…pecs, and scorer test

Address review feedback on PR #1485:
- docs/adapters/registry.md: fix tracking issues for Matrix (#309) and Zulip (#308)
- tools/spec-loop/specs/contributor-growth.md: list tools/chat-discord, remove extension point text, and note Slack or Discord in community signals
- tools/spec-loop/specs/adapters.md: add tools/chat-discord/ to frontmatter, align Slack/Discord adapter wording, and move none placeholder to tools/chat/
- plugins/magpie-setup/templates/project.md: document chat.guild_id in summary table and yaml example
- tools/chat/README.md: document chat.guild_id in yaml example and mention Discord bot token under $HOME in prerequisites
- tools/vendor-neutrality-score/tests/test_vendor_neutrality_score.py: test live repository tools loaded from disk rather than synthetic objects

Generated-by: Antigravity
@onlyarnav
onlyarnav force-pushed the docs/chat-discord-integration branch from d0c0a8e to 2caa40f Compare October 4, 2026 09:42

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks — all three earlier threads, the contributor-growth spec contradictions, and the Credentials clause are fixed. Two small config-wording issues remain inline (guild_id shipping as an active "..." value, and "channel names or IDs" promised contract-wide while the Slack adapter resolves names only), plus a nit. Merge still waits on #1484.

The PR description still says this PR marks contract:chat vendor-neutral and moves the score to 11/12 — that change now lives in #1484; please refresh the description (and "taxonomy" in the title) to match what this PR contains.


This review was drafted by an AI-assisted tool and
confirmed by an Apache Magpie maintainer. The findings
below are observations, not blockers; an Apache Magpie
maintainer — a real person — will take the next look at the
PR. If you think a finding is mis-applied, please reply on
the PR and a maintainer will weigh in.

More on how Apache Magpie handles maintainer review:
CONTRIBUTING.md.

Comment thread plugins/magpie-setup/templates/project.md Outdated
Comment thread tools/chat/README.md Outdated
Comment thread tools/spec-loop/specs/contributor-growth.md Outdated
@github-actions github-actions Bot added substrate:analytics Tool substrate: read-only metrics / dashboards / renderers substrate:framework-dev Tool substrate: build / validate / eval the framework itself labels Oct 5, 2026
onlyarnav added a commit that referenced this pull request Oct 5, 2026
…pecs, and scorer test

Address review feedback on PR #1485:
- docs/adapters/registry.md: fix tracking issues for Matrix (#309) and Zulip (#308)
- tools/spec-loop/specs/contributor-growth.md: list tools/chat-discord, remove extension point text, and note Slack or Discord in community signals
- tools/spec-loop/specs/adapters.md: add tools/chat-discord/ to frontmatter, align Slack/Discord adapter wording, and move none placeholder to tools/chat/
- plugins/magpie-setup/templates/project.md: document chat.guild_id in summary table and yaml example
- tools/chat/README.md: document chat.guild_id in yaml example and mention Discord bot token under $HOME in prerequisites
- tools/vendor-neutrality-score/tests/test_vendor_neutrality_score.py: test live repository tools loaded from disk rather than synthetic objects

Generated-by: Antigravity
@onlyarnav
onlyarnav force-pushed the docs/chat-discord-integration branch from 2caa40f to 8c6cc01 Compare October 5, 2026 17:46
@github-actions github-actions Bot added family:setup setup-* skills family:tools tools/* family:docs Docs, MISSION.md, READMEs labels Oct 5, 2026
@onlyarnav
onlyarnav added this pull request to stack #1534 October 5, 2026 17:52
Integrate tools/chat-discord into the chat contract documentation,
adapter registry, spec-loop specifications, and adopter project template.

- In docs/adapters/registry.md: update tracking issues for Matrix (#309) and Zulip (#308).
- In plugins/magpie-setup/templates/project.md and tools/chat/README.md: ship optional
  Discord-specific chat.guild_id commented out, clarify channel names as accepting IDs
  for Discord, and document Discord bot token under \C:\Users\arnav in prerequisites credentials.
- In tools/spec-loop/specs/adapters.md and contributor-growth.md: list tools/chat-discord
  as a shipping adapter under contract:chat, note chat covers Slack and Discord while
  Matrix and Zulip remain extension points with no adapter yet.

Generated-by: Antigravity
@onlyarnav
onlyarnav force-pushed the docs/chat-discord-integration branch from 8c6cc01 to 2d83965 Compare October 5, 2026 18:14
@onlyarnav onlyarnav changed the title docs(chat): integrate Discord adapter into registry, taxonomy, and project template docs(chat): integrate Discord adapter into registry and project template Oct 5, 2026

@potiuk potiuk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks — all three points from the last review are in (the commented-out guild_id in the template and the contract README, "channel names (Discord also accepts IDs)", and Matrix + Zulip in the contributor-growth spec), and the title and description now match what this PR contains. It's consistent with #1484's current head, so this is ready to land as soon as #1484 does.


This review was drafted by an AI-assisted tool and
confirmed by an Apache Magpie maintainer. The maintainer
approving this PR has read the findings and signed off. If
something feels off, please reply on the PR and a maintainer
will follow up.

More on how Apache Magpie handles maintainer review:
CONTRIBUTING.md.

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

Labels

contract:chat Tool capability: project chat reads (public channels only) family:docs Docs, MISSION.md, READMEs family:setup setup-* skills family:tools tools/* substrate:analytics Tool substrate: read-only metrics / dashboards / renderers substrate:framework-dev Tool substrate: build / validate / eval the framework itself

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(adapter/chat-discord): Discord adapter for contract:chat

2 participants