Clarify pet selection in skill

This commit is contained in:
Alvin Unreal 2026-05-14 22:07:46 +02:00
parent 3a62354bdc
commit 14055dac71
9 changed files with 23 additions and 15 deletions

View file

@ -11,7 +11,7 @@
</p>
<p align="center">
<img src="assets/hello.png" alt="OpenPets reacting across multiple coding agent sessions" width="100%" />
<img src="assets/intro.png" alt="OpenPets reacting across multiple coding agent sessions" width="100%" />
</p>
---
@ -33,14 +33,14 @@ Use the OpenPets skill. Install OpenPets for me, connect this agent, and verify
For project setup, open your agent inside the repo and say:
```text
Use the OpenPets skill. Make sure pet <petId> is installed, configure this project to use it, and verify the project integration.
Use the OpenPets skill. Help me choose or install a pet, configure it for this project, and verify the project integration.
```
Useful prompts:
```text
Use the OpenPets skill. Configure this project for Claude Code with pet <petId>.
Use the OpenPets skill. Configure this project for OpenCode with pet <petId>.
Use the OpenPets skill. Configure this project for Claude Code with a pet.
Use the OpenPets skill. Configure this project for OpenCode with a pet.
Use the OpenPets skill. Debug why openpets_status is unavailable.
```

Binary file not shown.

Before

Width:  |  Height:  |  Size: 859 KiB

BIN
assets/intro.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 762 KiB

View file

@ -105,7 +105,6 @@ npx -y @open-pets/mcp@latest --pet <pet-id>
## Public resources
- Website: https://openpets.dev
- Gallery: https://openpets.dev/gallery
- Pet catalog: https://openpets.dev/pets/catalog.v3.json
- GitHub issues: https://github.com/alvinunreal/openpets/issues

View file

@ -25,9 +25,10 @@ MCP package:
npx -y @open-pets/mcp@latest --pet <pet-id>
```
Pet catalog and gallery:
Pet catalog:
```text
https://openpets.dev/gallery
https://openpets.dev/pets/catalog.v3.json
```
For search, fetch `catalog.v3.json`, then fetch its `search` URL and the listed search pages. Use matching search entries' `catalogPage` values to fetch `catalog.v3/page-XXX.json` pages for install metadata.

View file

@ -6,7 +6,6 @@ Recommended public references:
```text
https://openpets.dev
https://openpets.dev/gallery
https://openpets.dev/pets/catalog.v3.json
```

View file

@ -6,18 +6,28 @@ Use this workflow when the user asks to configure the current project or a named
- Which agent/client should be configured? Common values: `claude`, `opencode`, `cursor`.
- Which project path should be configured?
- Which pet id should be selected?
- Which pet should be selected? If the user has not chosen one, list installed pets and use the catalog API to help them choose or install one.
- Is it okay to update project-local config files?
## Before configuring
Make sure the selected pet exists locally. List installed pets first:
Make sure the selected pet exists locally. If the user did not provide a pet id, start by listing installed pets:
```bash
openpets pets
```
If `<pet-id>` is not listed, install it before writing project config:
If the user wants a pet that is not installed, use the catalog API to confirm the pet id, then install it before writing project config.
- https://openpets.dev/pets/catalog.v3.json
Catalog search flow:
1. Fetch `catalog.v3.json`.
2. Fetch its `search` URL.
3. Fetch the listed `search-page-XXX.json` pages.
4. Match user words against each entry's `searchText`, `id`, and `displayName`.
5. Fetch the matching entry's `catalogPage` from `catalog.v3/page-XXX.json` to get install metadata.
```bash
openpets install <pet-id>

View file

@ -5,8 +5,7 @@ Use this workflow when the user asks to install a pet such as “install pet fox
## Steps
1. Confirm the pet id.
2. If the pet id is unclear, check the gallery or catalog:
- https://openpets.dev/gallery
2. If the pet id is unclear, search the catalog API rather than scraping the website.
- https://openpets.dev/pets/catalog.v3.json
3. Ensure the desktop app is running.
4. Install the pet:
@ -31,5 +30,5 @@ If the CLI is not installed globally, replace `openpets` with `npx -y @open-pets
## Notes
- Do not hard-code current pet IDs in answers; use the live catalog/gallery when uncertain.
- Do not hard-code current pet IDs in answers; use the live catalog API when uncertain.
- If the catalog or zip download fails, mention network access to `openpets.dev` and `zip.openpets.dev` may be required.

View file

@ -27,7 +27,7 @@ openpets pets
- Launch or relaunch the OpenPets desktop app.
- Re-run the relevant `openpets configure ...` command.
- Restart the agent/client after changing MCP/plugin/hook config.
- Use the gallery/catalog to confirm pet ids.
- Use the catalog API to confirm pet ids: https://openpets.dev/pets/catalog.v3.json
If the CLI is not installed globally, replace `openpets` with `npx -y @open-pets/cli@latest`.