repositories
loading repo index
repositories
loading repo index
repository
loading code, commits, and activity
Mirrored from https://github.com/ProjectOpenSea/opensea-skill
stars
latest
clone command
git clone gitlawb://did:key:z6MkqRzA...RfoM/ProjectOpenSea-...git clone gitlawb://did:key:z6MkqRzA.../ProjectOpenSea-...fef93001Release v2.14.09h ago| #1 | # skill — Agent Conventions |
| #2 | |
| #3 | Modular AI agent skills for interacting with OpenSea via Claude, Devin, and other AI assistants. Provides shell scripts, reference docs, and structured SKILL.md files for LLM consumption. |
| #4 | |
| #5 | ## Quick Reference |
| #6 | |
| #7 | This package is **not a pnpm workspace member** and is **not published to npm**, but it IS versioned (changesets) and IS published to **[ClawHub](https://clawhub.ai)** as `opensea/opensea-marketplace`. The release chain is: |
| #8 | |
| #9 | ``` |
| #10 | /release skill → changeset → version bump → tag `skill-vX.Y.Z` → monorepo GitHub release |
| #11 | ↓ |
| #12 | .github/workflows/sync-package.yml fires on `release: published` |
| #13 | ↓ |
| #14 | Public ProjectOpenSea/opensea-skill gets pushed code + `vX.Y.Z` tag + GitHub release |
| #15 | ↓ |
| #16 | Public repo's .github/workflows/clawhub-publish.yml fires on `release: published` |
| #17 | ↓ |
| #18 | `clawhub publish` → live at clawhub.ai under opensea/opensea-marketplace |
| #19 | ``` |
| #20 | |
| #21 | End-to-end, no human in the middle past the `/release` step. |
| #22 | |
| #23 | There is no build or test step. Changes are validated by reviewing the shell scripts and documentation manually. |
| #24 | |
| #25 | ## Architecture |
| #26 | |
| #27 | | File / Directory | Role | |
| #28 | |------------------|------| |
| #29 | | `SKILL.md` | Router entry point — directs agents to the correct sub-skill based on task | |
| #30 | | `opensea-api/SKILL.md` | Read-only queries: collections, NFTs, tokens, search, drops, events | |
| #31 | | `opensea-marketplace/SKILL.md` | Write operations: buy/sell NFTs, Seaport fulfillment, sweeps | |
| #32 | | `opensea-swaps/SKILL.md` | ERC20 token swaps via DEX aggregator | |
| #33 | | `opensea-wallet/SKILL.md` | Wallet provider setup: Privy, Turnkey, Fireblocks, Bankr, private key | |
| #34 | | `opensea-tool-sdk/SKILL.md` | Build/register/gate AI agent tools (ERC-8257) | |
| #35 | | `package.json` | Metadata only (private, not published) | |
| #36 | | `.env.example` | Required and optional environment variables | |
| #37 | |
| #38 | ## Review Checklist |
| #39 | |
| #40 | When reviewing changes to this package, verify: |
| #41 | |
| #42 | 1. **SKILL.md files are the source of truth for agents**. They must accurately reflect the current CLI commands, API endpoints, and shell scripts. Outdated examples cause agents to fail silently. |
| #43 | |
| #44 | 2. **No duplication across sub-skills**. The wallet provider table lives only in `opensea-wallet`. `opensea-post.sh` lives only in `opensea-api/scripts/`. Other skills link to these canonical locations. |
| #45 | |
| #46 | 3. **Shell scripts are self-contained**. Each script should work with just `OPENSEA_API_KEY` set and `curl` + `jq` available. Do not add dependencies on Node.js or other tools. |
| #47 | |
| #48 | 4. **Security**: This package is mirrored to a public repo. Never include API keys, internal URLs, or private infrastructure details. Treat all content as publicly visible. |
| #49 | |
| #50 | 5. **CLI parity**: The skills recommend `@opensea/cli` as the preferred interface. When CLI commands change in `packages/cli`, update the corresponding examples in the relevant sub-skill SKILL.md. |
| #51 | |
| #52 | 6. **Reference doc accuracy**: Files in sub-skill `references/` directories describe protocol details. Verify they match the current SDK and API behavior. |
| #53 | |
| #54 | ## Conventions |
| #55 | |
| #56 | - All shell scripts use `#!/usr/bin/env bash` and read `OPENSEA_API_KEY` from the environment. |
| #57 | - Scripts output JSON by default (piped through `jq` when available). |
| #58 | - SKILL.md frontmatter declares required/optional env vars and dependencies. |
| #59 | - Meaningful changes to this package should use `/release` so a new ClawHub version ships end-to-end. **Do not write a changeset for `@opensea/skill`** — skill is excluded from `pnpm-workspace.yaml`, so `pnpm changeset version` would fail. The `/release` skill walks through the manual flow instead: bump `packages/skill/package.json` by hand (semver: minor for new features/scripts, patch for fixes/docs), prepend a matching `CHANGELOG.md` entry, then tag and release as usual. |
| #60 | - `/sync` (a code-only `workflow_dispatch` push to the public mirror) is reserved for changes that should NOT cut a new ClawHub version — purely-internal CI/workflow tweaks, README typo fixes, or one-off code-mirror refreshes. |
| #61 | - **Never open PRs against the public `opensea-skill` repo** — all changes go through this monorepo. |
| #62 |