Skip to content

The Claude Code plugin README says what the plugin sends, runs and keeps - #731

Open
zlareb1 wants to merge 3 commits into
mainfrom
docs/plugin-readme-data-handling
Open

zlareb1 wants to merge 3 commits into
mainfrom
docs/plugin-readme-data-handling

Conversation

@zlareb1

@zlareb1 zlareb1 commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

Changelog category (leave one):

  • Documentation (changelog entry is not required)

Changelog entry (one or two sentences a user of Loom can read without the diff; the release pull request collects these into the release notes):

...

Why

The Claude Code plugin's README only linked data handling as ../../docs/features/integrations/claude-code.md#data-handling. That link breaks for anyone who installs the plugin folder alone, which is what a plugin directory serves, and a reader of the README had no statement of what the plugin sends, runs or keeps. The README now has a ## Data handling section that says it in one place: what goes to the configured Loom server, which local commands the hooks run, what stays on the machine and for how long, which two skills reach other services and when (on Linux loom-status runs NodeSource's setup script or apk add nodejs as root or with passwordless sudo; on macOS it runs Homebrew as the user), that the server passes text to an LLM or embedding provider only if its operator configured one, that a user-scope loom MCP entry beside the plugin registers a second server, and that SessionStart reads ~/.claude.json locally to warn about one. The agent-mode token's file and the public issue's full contents are named too. The full list stays on the docs page, now linked with an absolute URL, as is the MCP clients link.

The hooks page's "What the hooks do" now names the local commands too: node, git (remotes, branch, status, diffs), grep for a redirected grep pattern, and, at Stop in an indexed checkout when the test gate names a pytest test and neither the checkout's virtualenv nor an active one exists, python3 -c "import pytest" (then python) to see whether pytest is installed (LOOM_TEST_GATE=off). The README's remaining links that pointed outside the plugin folder (requirements, Codex) are absolute now.

Each item was checked against the plugin on main: the session-memory hand-off (hooks/loom-session-memory.mjs, LOOM_SESSION_MEMORY=off), the local grep (lib/code-shunt.mjs runLocalGrep), the test gate (hooks/loom-test-gate.mjs, LOOM_TEST_GATE), the agent-mode exchange (LOOM_CLIENT_ID, hooks/HOOKS.md), the shunt log (LOOM_SHUNT_LOG, kept out of the temp sweep in lib/tmp-state.mjs) and the two skills' outside calls, as the Data handling section of docs/features/integrations/claude-code.md lists them.

Scope and risk

Docs only: integrations/claude-code-plugin/README.md and docs/features/integrations/claude-code.md. No hook, lib, bin, skill or manifest changes, so no plugin version bump.

Compatibility, rollout and rollback

  • Wire: none.
  • Operator steps: none.
  • Rollback: revert.

Tests

  • tests/unit/test_published_links.py now reads the plugin README too, and checks its github.com/ClickHouse/loom/tree/main/... folder links as well as its site links, since a plugin directory serves this README alone.
  • tests/unit/test_doc_links.py, test_public_copy.py, test_agent_instructions.py, test_published_links.py: 448 passed.
  • node --test integrations/claude-code-plugin/tests/*.test.mjs: 609 passed.
  • Prettier clean. check_prose.py flags only four lines already on main (/opt/homebrew, /opt/local paths in install notes).

AI assistance in the code (leave one; writing this description with AI is fine):

  • AI-generated (an agent wrote most of the diff): Claude Code wrote the section from the plugin's data-handling docs and checked each item against the plugin code.

  • I can explain every line of this diff and how it interacts with the rest of Loom.

Checklist

  • make format-check, make lint, make typecheck and make test-unit pass; the integration suite passes if server behaviour changed. (Docs only: ran the doc and plugin tests above; CI runs the rest.)
  • Docs under docs/ describe the system as it now is, and this description names any operator steps and wire changes.
  • Repository text has no dates, people, host names, internal namespaces, ticket or decision numbers; the history goes in this description (tests/unit/test_public_copy.py).
  • Commits are signed off (git commit -s), as CONTRIBUTING.md asks.

🤖 Generated with Claude Code

zlareb1 and others added 3 commits November 16, 2026 07:38
…eps, and the hooks page names the local commands

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
… outbound calls, the full repository identity, the exact Python probe and what temp files keep

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
…e.json read, the issue's full report, agent-mode token storage and the active virtualenv, and its links are tested

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant