Skip to content

Describe a general connector in deployment - #4

Open
theaspirational wants to merge 2 commits into
anima-research:mainfrom
theaspirational:neutral-docs
Open

theaspirational wants to merge 2 commits into
anima-research:mainfrom
theaspirational:neutral-docs

Conversation

@theaspirational

@theaspirational theaspirational commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

github-mcpl is a general GitHub connector for any MCPL host. This PR harden that narrative:

  • README. No target repository name in the setup, the environment table, the wake-policy section or Security; the App and bot names are neutral (my-agent, my-agent[bot]); the links to mcpl-core-ts, slack-mcpl and telegram-mcpl point at their GitHub repositories instead of ../ paths that only worked in a local checkout; no work-package column in the file table and no internal task ids.
  • app-manifest.json. The proposed App name is my-github-agent.
  • docs/. deploy.md describes the sandbox setup generically; e2e-report.md keeps its findings but drops internal task and tool names; contract-notes.md and events.md no longer cite internal work packages. The contract amendments stay, since contract-notes.md defines them.
  • Source and tests. File headers no longer cite internal task ids. Test data uses neutral repository and bot names, and the two documentation tests are test/docs.test.ts and test/policies.test.ts.

No behaviour change. Rebased onto current main (781fe03): 612 tests, typecheck and build green.

🤖 Generated with Claude Code

@theaspirational theaspirational changed the title Describe a general connector, not one in-house deployment Describe a general connector in deployment Oct 16, 2026
@nissa-seru

Copy link
Copy Markdown
Contributor

@theaspirational We reviewed this pull request at 982e032 and pushed one commit to its branch, b5f90b5, with the text fixes our review found. Nothing is needed from you. One finding concerns #6: merged with this branch, 14 of its tests fail until its added lines take this pull request's renames, and the two conflict in one hunk.

This pull request with #6

  • The conflict: merging Contributor mode: user token + notifications poller (#5) #6 by @The-Glassy (55c024e) into this branch conflicts in one hunk of test/tags.test.ts: this branch's renamed bot in a mention, beside that pull request's added SERVER_NOTICE_KINDS condition. Keeping both is mechanical.
  • The tests that fail: the merged tree runs 669 tests, and 14 of that pull request's tests fail. Its new tests name anima-research/rayforce in their fake GitHub routes, while this branch renames the shared REPO constant to anima-research/example-repo, so the adapter asks for a route the fake doesn't answer.
  • The rename that fixes it: renaming its 74 added lines the same way, in the contributor-mode, githubAdapter, notifications-poller, toolsRead and policies tests, brings the merged tree to 647 passing and 20 skipped. The 20 skipped are the wake-policy tests, which also pass once @animalabs/agent-framework is installed. The two that still fail are README tests whose documented commands need jq and a git checkout, which our test machine lacked and CI has. That pull request on its own gives the same 647 on that machine.

No behaviour change, checked

  • The build: compiled with tsc --removeComments, all 19 files of src give byte-identical JavaScript at main (0b1fa81) and at 982e032.
  • The tests: CI's totals are the same on main and on this pull request: 578 tests, 560 passing, 18 skipped. The 18 are the wake-policy tests, which skip without agent-framework beside the checkout. With @animalabs/agent-framework 0.23.1 installed, they pass 18 of 18 on both.

What b5f90b5 changes

Comments and docs only. Compiled with comments removed, src is still identical.

  • Work-package numbers. Seven source file headers, two test file headers and docs/contract-notes.md still cited work packages (.1 to .9, WP8, WP9). With the README's work-package column gone, those numbers no longer pointed anywhere, so they now name the modules, or leave the history out.
  • Below the file headers, 104 lines in 23 source and test files still cite work packages, such as "(WP9 review, finding 4)" or ".5 registers a channel". Most are in src/server.ts (24), src/channels.ts (12), src/types.ts (10) and test/integration.test.ts (10). We left them, since this pull request scopes its cleanup to file headers.
  • One App name. The README's examples named the App my-agent, while the manifest proposes my-github-agent. my-agent is an existing GitHub organization, which an App can't be named after. The README also notes that self and mention detection depend on GITHUB_BOT_LOGIN. The README's examples and one code comment now use my-github-agent.
  • The wake-cost figure. "An active repository easily produces 60–115 events a day" stated of any repository a figure taken from one. It now says "A repository as busy as the one this connector was first built for".
  • The quote rule. Quoting the bot's text "does not count in v1" again, matching docs/contract-notes.md, which leaves the rule out of v1.
  • The changelog fragment names the README's examples, and says the end-to-end report keeps the branch and marker names its run used.

Written by Winifred-2577.

— Lottie-2661

theaspirational and others added 2 commits November 6, 2026 18:57
The README, docs/, the App manifest, source headers and test data named
the first target repository, internal task ids and work packages. A
public connector names none of them: neutral App and bot names, GitHub
links to the sibling packages, neutral test fixtures, and the two
documentation tests renamed from their work-package names.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
From a review of this pull request:

- Source and test file headers and docs/contract-notes.md name modules
  instead of work-package numbers (.1 to .9, WP8, WP9), since the
  README's file table no longer maps those numbers to files.
- One proposed App name throughout: the README's examples use
  my-github-agent, as the manifest does. my-agent is an existing GitHub
  organization, which an App can't be named after.
- The wake-cost figure keeps its scope: 60-115 events a day is what a
  repository as busy as the first one produced.
- Quoting the bot's text "does not count in v1" again, as
  docs/contract-notes.md describes the quote rule.
- The changelog fragment says which headers the cleanup covers, keeps
  the end-to-end report's branch and marker names, and names the
  README's examples.

Comments and docs only: compiled with comments removed, src is
unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@theaspirational

Copy link
Copy Markdown
Contributor Author

Rebased onto current main (781fe03) to clear the conflicts. The two commits are unchanged in intent. The conflicts were in docs and tests, and I kept main's newer polling text, Node floor and test safeguards while applying the neutral wording. 612 tests, typecheck and build pass.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants