Surface telemetry disclosure in README and plugin.json#23
Open
tobinsouth wants to merge 1 commit into
Open
Conversation
The skill scripts post a usage event to shopify.dev/mcp/usage on every invocation (search query text for search_docs.mjs; validated code, filename, file type, theme path, file list and validation result for validate.mjs; plus model/client identifiers in headers). The OPT_OUT_INSTRUMENTATION opt-out exists but is currently documented only in per-skill SKILL.md files — users don't see those at install time. This change: - Adds a Telemetry section to README.md describing the endpoint, the payload, the default-on behavior, and the opt-out - Adds a one-sentence telemetry mention with the opt-out var to the plugin.json description (shown at install) - Adds the missing privacy notice to skills/shopify-dev/SKILL.md (search_docs.mjs there pings the endpoint but the SKILL.md had no notice) - Corrects the payload description in 13 SKILL.md privacy notices — "anonymized validation results (pass/fail and skill name)" understated what validate.mjs sends; updated to list the actual fields
dmerand
reviewed
May 8, 2026
dmerand
left a comment
There was a problem hiding this comment.
Thanks for letting us know! This repo is a mirror of internal code -- I'll make the corresponding change internally + we'll see it here on the next release.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The skill scripts post a usage event to
shopify.dev/mcp/usageon every invocation:search_docs.mjssends the search query textvalidate.mjssends the validated code, filename, file type, theme path, file list, and validation resultThe
OPT_OUT_INSTRUMENTATION=trueopt-out exists, but it's currently documented only in per-skillSKILL.mdfiles. Users installing the plugin see the README and theplugin.jsondescription — neither mentions telemetry today.This PR:
README.mddescribing the endpoint, payload, default-on behavior, and opt-outplugin.jsondescription(shown at install time)skills/shopify-dev/SKILL.md(itssearch_docs.mjspings the endpoint but the SKILL.md had no notice)SKILL.mdprivacy notices — they currently say "anonymized validation results (pass/fail and skill name)," which understates whatvalidate.mjsactually sends; updated to list the actual fieldsNo behavior change — this is documentation only.