Document MCP access and dashboard in README, add MIT license - #19
Conversation
Adds an MCP access section (tools, token setup) and a Dashboard section since both existed but weren't documented, bumps the badge display size so the XP label is readable, and adds a LICENSE file plus badge.
The latest updates on your projects. Learn more about Vercel for GitHub.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 5 remain after this review. 📝 WalkthroughWalkthroughThe project now includes an MIT license, MIT package metadata, updated badge dimensions, dashboard-based repository guidance, and documentation for dashboard and MCP access. ChangesLicensing and documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk:⚪ Minimal · up to This PR updates documentation, licensing metadata, and badge presentation without introducing an actionable merge-blocking risk; it is merge-ready after normal checks and review. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 1 files. (1 skipped: 1 unsupported.)
✨ Finishing Touches 💡 1📝 Generate docstrings 💡
🧪 Generate unit tests (beta)
Comment |
| 3. **Drop the badge in your own README**, swapping in that ID: | ||
| ```md | ||
| <img src="https://commit-pet.vercel.app/api/badge/<repoId>" alt="commit-pet badge" width="150" height="220" /> | ||
| <img src="https://commit-pet.vercel.app/api/badge/<repoId>" alt="commit-pet badge" width="195" height="286" /> |
There was a problem hiding this comment.
Dashboard copies stale badge dimensions
Dashboard BadgeCard still builds snippet with width="150" height="220", which CopyButton copies while the README specifies width="195" height="286" — should we update the Dashboard snippet to width="195" height="286"?
Want Baz to fix this for you? Activate Fixer
Other fix methods
Prompt for AI Agents
Before applying, verify this suggestion against the current code. In README.md around
lines 20-20, align the Dashboard `BadgeCard` copyable HTML snippet with the documented
badge dimensions. Update the BadgeCard implementation so the `CopyButton` receives
`width="195" height="286"` instead of `150x220`, ensuring dashboard-generated
installation snippets match the README.
There was a problem hiding this comment.
Commit 69e9121addressed this comment by updating the Dashboard BadgeCard copyable snippet to use width="195" height="286", matching the README dimensions.
| ## Dashboard | ||
| Sign in with GitHub on [the dashboard](https://commit-pet.vercel.app/dashboard) to see every repo you have commit-pet installed on, in one place — the same live pet state as the badge, plus each repo's numeric ID for badge setup and its **MCP access** card for generating a token (see below). |
There was a problem hiding this comment.
Contradictory Dashboard availability guidance
The new Dashboard description presents it as available while the badge paragraph still calls it an “eventual dashboard,” so readers get conflicting guidance — should we update the earlier wording or remove “eventual”?
Want Baz to fix this for you? Activate Fixer
Other fix methods
Prompt for AI Agents
Before applying, verify this suggestion against the current code. In `README.md` around
lines 47-51, update the badge description and Dashboard section so they consistently
describe the dashboard as currently available. Remove or replace the phrase “eventual
dashboard” in the badge paragraph, preserving the intended distinction between the
badge view and the dashboard.
There was a problem hiding this comment.
Commit 69e9121addressed this comment by removing “eventual dashboard” and documenting the dashboard as currently available.
| | Tool | Description | | ||
| | ------------------ | ---------------------------------------------------------------------------------------------------------------------- | | ||
| | `get_pet_status` | Get the pet's phase (development/deployed), health, mood, growth stage, XP, and open issue count. | | ||
| | `mark_deployed` | Mark the pet as deployed, entering the deployed phase. Idempotent. | |
There was a problem hiding this comment.
Repeated deploy calls reset displayed deployment time
mark_deployed calls markDeployed(repoId) with updatedAt: new Date() even when phase is already deployed, so getDashboardPet/getDashboardPets feed a new deployedRelative value to Hero and PetCard, making old deployments appear current — should we update the timestamp only on the phase transition or add deployedAt, while preserving the existing found-row result semantics?
Want Baz to fix this for you? Activate Fixer
Other fix methods
Prompt for AI Agents
Before applying, verify this suggestion against the current code. In README.md around
line 70, follow the documented `mark_deployed` behavior into the `markDeployed(repoId)`
implementation and fix its idempotency bug. Preserve the original deployment timestamp
when the repository is already in the `deployed` phase by updating `updatedAt` only on
the phase transition or by introducing a dedicated immutable `deployedAt` field, while
retaining the existing found-row result semantics. Ensure dashboard mappings and
`Hero`/`PetCard` continue to display the original deployment time after repeated calls.
BadgeCard's copy snippet still used the old 150x220 badge dimensions, and the "How it works" section called the dashboard "eventual" even though it's documented as available a few lines later.
User description
Summary
/api/mcpendpoint, per-repo token setup, and the 3 available tools (get_pet_status,mark_deployed,mark_issue_fixed)<img>display size (150×220 → 195×286) so the XP label is legibleLICENSEfile,licensefield inpackage.json, and a license badge in the READMETest plan
app/api/mcp/route.tsapp/dashboard/page.tsx,app/dashboard/[repoId]/page.tsx)🤖 Generated with Claude Code
Generated description
Below is a concise technical summary of the changes proposed in this PR:
Document the dashboard sign-in flow and MCP access through the README, including endpoint configuration, repository-scoped tokens, and available tools. Add MIT licensing metadata and enlarge generated badge embeds for better readability.
Modified files (3)
Latest Contributors(0)
get_pet_status,mark_deployed, andmark_issue_fixed.Modified files (2)
Latest Contributors(0)