docs: make the repository easier to find - #1
Merged
Merged
Conversation
The English and Chinese README intros now lead with "computer use for Grok Build" and name the supported platforms. The facade package gains PyPI keywords, classifiers and project URLs that link back to this repository, and its README uses absolute links so they also work on PyPI. The marketplace entry gets a homepage and brand-scoped keywords. Grok Build suggests a plugin when one of its keywords appears in the user's prompt, so generic words like "browser" or "testing" fired on unrelated requests, and xai-org/plugin-marketplace rejects them. goal.md §4.2 records the rule. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
1 participant
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.
Summary
Makes the repository easier to find on GitHub, PyPI and in Grok Build's plugin suggestions. The only behavior change is which prompts trigger the plugin's install suggestion.
servers/grok-computer-mcp/pyproject.toml: more PyPI keywords; classifiers for audience, operating systems and topics; and[project.urls](Homepage, Repository, Issues) so the PyPI page links back to this repository. This takes effect with the next release, because the package is not on PyPI yet.servers/grok-computer-mcp/README.md(the PyPI long description): absolute links to the repository and the install guide. Relative links break on PyPI..grok-plugin/marketplace.json: addshomepageand replaces the generic keywords with brand-scoped ones (computer-use,computer use,grok computer,grok-computer-mcp). Grok Build's suggestion matcher (xai-grok-plugin-marketplace/src/matcher.rs) suggests a plugin when one of its keywords appears in the user's prompt at word boundaries. The old keywordsgui,desktop,browserandtestingwould therefore fire on unrelated requests. The xai-org/plugin-marketplace contributing guide also sends back submissions that use generic keywords or have no homepage.scripts/plugin_index.py --entrycopies these fields into the entry for that catalog.plugin.jsonis unchanged.docs/goal.md§4.2: adds an implementation note that records the keyword rule.Done separately, not part of this PR: the GitHub About section now has a description and 20 topics.
Test plan
uv run pytest: 1025 passed, 5 skipped (no desktop session; no Python 3.8 on PATH)uv run ruff checkanduv run pyrightare cleanuv run python scripts/plugin_index.py --checkgrok plugin validate plugins/computer-useuv lock --checkuv build --package grok-computer-mcp: the wheel METADATA has the new Project-URL, Keywords and Classifier lines🤖 Generated with Claude Code