Skip to content

Commit 608f89d

Browse files
Refined README & Contrib guides
X-Lovable-Edit-ID: edt-02052f77-9c7a-4d9d-a135-431fd54fdcc0 Co-authored-by: criptogus <128640021+criptogus@users.noreply.github.com>
2 parents a26cf51 + 0acf0ed commit 608f89d

3 files changed

Lines changed: 230 additions & 81 deletions

File tree

CONTRIBUTING.md

Lines changed: 114 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,152 @@
11
# Contributing to Super Agent Skill
22

3-
Thanks for wanting to make agents smarter. There are three kinds of contributions we love:
3+
> **First time here? Welcome.** This is one of the friendliest places to ship your first open-source contribution — most PRs land within 72h, and every accepted package goes live to thousands of agents through MCP.
44
5-
1. **New packages** — a skill, playbook, soul or guardrail in `content/`.
6-
2. **Improvements to existing packages** — better prompts, tighter rules, more examples, fixed edge cases.
7-
3. **Code & docs** for the platform itself (in `src/`).
5+
There are four flavors of contribution we love:
6+
7+
1. 🛠 **New packages** — a Skill, Playbook, Soul or Guardrail in [`content/`](content/).
8+
2.**Improvements to existing packages** — sharper prompts, tighter rules, more examples, fixed edge cases, better adversarial coverage.
9+
3. 💻 **Code & docs** for the platform itself (in [`src/`](src/)).
10+
4. 🐛 **Bug reports, ideas, security disclosures** — issues are contributions too.
811

912
By submitting a contribution you agree to license your work under the project's licenses (Apache 2.0 for code, CC BY-SA 4.0 for content).
1013

11-
## Contributing a package
14+
---
15+
16+
## 🚀 Fast path: ship a Skill in 15 minutes
17+
18+
```bash
19+
# 1. Fork on GitHub, then:
20+
git clone git@github.com:<you>/agent-evolve-network.git
21+
cd agent-evolve-network
22+
bun install
23+
24+
# 2. Copy a template
25+
cp content/skills/_template.yaml content/skills/my-skill.yaml
1226

13-
### 1. Pick the right type
27+
# 3. Fill in: name, slug, description, system prompt, rules, examples
28+
$EDITOR content/skills/my-skill.yaml
1429

15-
| You want to... | Use |
30+
# 4. Validate (same script CI runs)
31+
bun run validate:content
32+
33+
# 5. Commit, push, open a PR using the "Package submission" template
34+
```
35+
36+
That's it. A maintainer reviews for quality, safety and overlap with existing packages. Accepted packages are imported into the hosted registry on the next sync, where **SkillForge** evaluates them and serves the strongest version through MCP.
37+
38+
---
39+
40+
## 📦 Contributing a package
41+
42+
### Step 1 — Pick the right type
43+
44+
| You want to… | Use a… |
1645
| --- | --- |
1746
| Encapsulate a single capability with a contract (input → output) | **Skill** |
1847
| Codify a multi-step workflow that calls skills/tools in sequence | **Playbook** |
1948
| Define a persona, voice and value system for an agent | **Soul** |
2049
| Add safety, compliance or policy rules | **Guardrail** |
2150

22-
### 2. Copy the template
51+
When in doubt, **split**. Two small skills beat one bloated one.
52+
53+
### Step 2 — Copy the template
2354

2455
```bash
25-
cp content/skills/_template.yaml content/skills/my-skill.yaml
56+
cp content/<type>/_template.yaml content/<type>/<your-slug>.yaml
2657
```
2758

28-
Templates live next to the examples in each folder.
59+
Templates live next to working examples in each folder — read those first; they're the best docs we have.
2960

30-
### 3. Fill it in — quality bar
61+
### Step 3 — Hit the quality bar
3162

32-
A package will only be accepted if it:
63+
A package is accepted when it:
3364

34-
- Has a clear, scoped purpose (do one thing well — split it if it doesn't fit on a page).
35-
- Includes **at least 2 worked examples** with realistic input and the exact expected output.
36-
- States `must` and `must_not` rules explicitly.
37-
- Uses a unique kebab-case `slug` not already in the registry.
38-
- Is original work, public-domain, or properly attributed.
39-
- Contains no secrets, PII, or copyrighted prompts pulled from a paid product.
65+
- ✅ Has a **clear, scoped purpose** — does one thing well.
66+
- ✅ Includes **at least 2 worked examples** with realistic input and the exact expected output.
67+
- ✅ States **`must` and `must_not`** rules explicitly (no hand-waving).
68+
- ✅ Uses a **unique kebab-case `slug`** not already in the registry.
69+
- ✅ Is **original work**, public domain, or properly attributed.
70+
- ✅ Contains **no secrets, PII, or copyrighted prompts** pulled from a paid product.
71+
- ✅ Passes `bun run validate:content` locally.
4072

41-
### 4. Validate
73+
### Step 4 — Validate
74+
75+
```bash
76+
bun run validate:content
77+
```
78+
79+
The validator checks schema, slug uniqueness, file naming and example count. CI runs the same script on every PR.
80+
81+
### Step 5 — Open a pull request
82+
83+
Use the **Package submission** PR template. Include:
84+
85+
- Why this package exists (the problem it solves in one sentence).
86+
- How you tested it — at minimum, paste 1 real run from a real agent.
87+
- Any prior art / inspirations / overlap with existing packages.
88+
89+
A maintainer reviews within **72 hours**. Expect tiny nits — we're picky on purpose, because every package gets amplified across the network.
90+
91+
---
92+
93+
## 🛠 Improving an existing package
94+
95+
- For **prompt tweaks, new examples, edge-case fixes** — just open a PR. Bump the `version` field (semver).
96+
- For **structural changes** (rename, breaking rule changes) — open an issue first so we can coordinate with downstream agents already depending on the slug.
97+
- For **drift fixes** flagged by SkillForge — mention the drift alert ID in your PR; we'll close it automatically on merge.
98+
- Always describe in the PR: **what got better, how you tested, what regressed (if anything)**.
99+
100+
---
101+
102+
## 💻 Code contributions
103+
104+
- Match existing style — Prettier + ESLint run automatically.
105+
- Keep PRs focused: **one concern per PR**.
106+
- For non-trivial changes (>200 LOC or new dependencies), open an issue first to align on direction.
107+
- Add or update tests next to changed logic.
108+
- If you touch the MCP surface, update [`docs/mcp.md`](src/routes/docs.mcp.tsx) too.
109+
110+
Local dev:
42111

43112
```bash
44113
bun install
114+
bun run dev # http://localhost:5173
115+
bun test # unit tests
45116
bun run validate:content
46117
```
47118

48-
The validator checks the schema, slug uniqueness and example count. CI runs the same script on your PR.
119+
---
120+
121+
## 🐛 Reporting issues
122+
123+
| Type | How |
124+
| --- | --- |
125+
| Bug in the platform | Open an issue with the **Bug** template |
126+
| Problem with a package | Open an issue with the **Content** template + the slug |
127+
| Feature idea | **Feature request** template — describe the user, not the solution |
128+
| Security vulnerability | **Please do NOT open a public issue.** See [SECURITY.md](SECURITY.md) |
129+
130+
---
49131

50-
### 5. Open a pull request
132+
## 🏷 Good first issues
51133

52-
Use the **Package submission** PR template. A maintainer will review for quality, safety and overlap. Accepted packages are imported into the hosted registry on the next sync, where SkillForge starts evolving them.
134+
New contributors: filter issues by [`good first issue`](https://github.com/criptogus/agent-evolve-network/labels/good%20first%20issue) and [`help wanted`](https://github.com/criptogus/agent-evolve-network/labels/help%20wanted). Most are mergeable in one focused afternoon.
53135

54-
## Improving an existing package
136+
If something's labeled but unclear, **comment first** and a maintainer will scope it down before you start.
55137

56-
- Open an issue first if the change is structural (rename, breaking rules, etc.).
57-
- For prompt tweaks and new examples, just open a PR.
58-
- Bump the package's `version` field following semver.
59-
- Note the change in the PR description — what got better and how you tested it.
138+
---
60139

61-
## Code contributions
140+
## 🤝 Code of Conduct
62141

63-
- Match existing style (Prettier + ESLint).
64-
- Keep changes focused — one concern per PR.
65-
- For non-trivial changes, open an issue first to align on direction.
142+
All participation — issues, PRs, Discord, comments — is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). Be kind. Critique ideas, not people. We enforce it.
66143

67-
## Reporting issues
144+
---
68145

69-
- **Bug or content problem:** use the matching issue template.
70-
- **Security vulnerability:** see [SECURITY.md](SECURITY.md) — please do **not** open a public issue.
146+
## 🌟 Recognition
71147

72-
## Code of Conduct
148+
- Every merged contributor is listed in the [`AUTHORS`](AUTHORS) file and on the [public marketplace](https://www.superagentskill.com/marketplace/rankings).
149+
- Top contributors get the **Skill Architect** role on Discord, early access to new features, and a small monthly grant from the platform revenue pool.
150+
- **Found a robustness issue?** It's published as a public finding (e.g. `SAS-2026-0042`) with your handle credited — CVE-style.
73151

74-
All participation is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
152+
Thanks for making agents smarter — together. ⭐

README.md

Lines changed: 115 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,154 @@
11
<div align="center">
22

3+
<img src="https://www.superagentskill.com/og.png" alt="Super Agent Skill" width="640" />
4+
35
# Super Agent Skill
46

5-
**Open registry of Skills, Playbooks, Souls and Guardrails for AI agents — distributed over MCP.**
7+
### One command. Your agent becomes a genius.
8+
9+
**The open MCP layer that turns any AI agent — Claude, Cursor, Codex, Continue — into a specialist, instantly.**
10+
11+
[![Website](https://img.shields.io/badge/website-superagentskill.com-0A66FF?style=flat-square)](https://www.superagentskill.com)
12+
[![MCP](https://img.shields.io/badge/MCP-live-22c55e?style=flat-square)](https://www.superagentskill.com/api/mcp)
13+
[![Marketplace](https://img.shields.io/badge/marketplace-browse-8b5cf6?style=flat-square)](https://www.superagentskill.com/marketplace)
14+
[![License: Apache 2.0](https://img.shields.io/badge/code-Apache_2.0-000?style=flat-square)](LICENSE)
15+
[![License: CC BY-SA 4.0](https://img.shields.io/badge/content-CC_BY--SA_4.0-000?style=flat-square)](LICENSES/CONTENT-CC-BY-SA-4.0.txt)
16+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-ff4f8b?style=flat-square)](CONTRIBUTING.md)
617

7-
[Website](https://www.superagentskill.com) · [Marketplace](https://www.superagentskill.com/marketplace) · [Docs](https://www.superagentskill.com/docs) · [MCP endpoint](https://www.superagentskill.com/api/mcp)
18+
[**Website**](https://www.superagentskill.com) · [**Marketplace**](https://www.superagentskill.com/marketplace) · [**Docs**](https://www.superagentskill.com/docs) · [**MCP endpoint**](https://www.superagentskill.com/api/mcp) · [**Discord**](https://www.superagentskill.com/community)
819

920
</div>
1021

1122
---
1223

13-
Super Agent Skill is two things:
24+
## Why Super Agent Skill?
1425

15-
1. **A hosted platform** at [superagentskill.com](https://www.superagentskill.com) that runs the *SkillForge* evolution loop — it scores skills, finds weaknesses, patches them, and serves the best version through MCP to any compatible agent (Claude, Cursor, Codex, Continue, etc.).
16-
2. **An open registry** (this repo) of community-maintained `skills/`, `playbooks/`, `souls/` and `guardrails/`. Anything in `content/` is free to download, fork, remix and embed — under [CC BY-SA 4.0](LICENSES/CONTENT-CC-BY-SA-4.0.txt). The application code is [Apache 2.0](LICENSE).
26+
Generic agents are jacks of all trades, masters of none. They hallucinate, drift, and forget the rules your team actually cares about.
1727

18-
> **Why open source it?** The MCP improvement loop only matters if there is a thriving catalog to improve. We want the catalog to belong to the community.
28+
**Super Agent Skill fixes that with three ingredients:**
1929

20-
## What lives in `content/`
30+
- 🧠 **A growing open registry** of battle-tested **Skills**, **Playbooks**, **Souls** and **Guardrails** — community-owned, MIT-friendly, embeddable anywhere.
31+
- ⚙️ **SkillForge**, our continuous evolution loop — it benchmarks every skill against adversarial cases, finds weaknesses, and ships patches automatically.
32+
- 🔌 **One MCP endpoint** that streams the strongest version of every skill to any compatible agent — no copy-paste, no version drift.
2133

22-
| Folder | What it is | Schema |
23-
| --- | --- | --- |
24-
| [`content/skills/`](content/skills) | A focused capability with a system prompt, rules, examples, and a runnable contract | [`schemas/skill.schema.json`](content/schemas/skill.schema.json) |
25-
| [`content/playbooks/`](content/playbooks) | A multi-step procedure that orchestrates skills/tools to reach an outcome | [`schemas/playbook.schema.json`](content/schemas/playbook.schema.json) |
26-
| [`content/souls/`](content/souls) | A persona/identity bundle — voice, values, defaults — that wraps any agent | [`schemas/soul.schema.json`](content/schemas/soul.schema.json) |
27-
| [`content/guardrails/`](content/guardrails) | Safety, compliance and policy rules attached to a skill or soul | [`schemas/guardrail.schema.json`](content/schemas/guardrail.schema.json) |
34+
> *Think GitHub for prompts × npm for agent capabilities × Wikipedia for AI behavior — all under MCP.*
35+
36+
## 60-second quickstart
2837

29-
Each item is a single self-contained YAML or JSON file. Browse the folders for working examples.
38+
**Option A — Plug it into your agent (recommended).** Point any MCP-compatible client at:
3039

31-
## Use a package
40+
```
41+
https://www.superagentskill.com/api/mcp
42+
```
3243

33-
**Download directly** (no account needed):
44+
That's it. Your agent now has discover / install / evaluate tools and live access to every skill in the registry.
45+
46+
**Option B — Download a skill as a file.** Free, no account:
3447

3548
```bash
36-
curl -O https://raw.githubusercontent.com/<org>/super-agent-skill/main/content/skills/code-reviewer.yaml
49+
curl -O https://raw.githubusercontent.com/criptogus/agent-evolve-network/main/content/skills/code-reviewer.yaml
3750
```
3851

39-
**Or stream the live, evolving version through MCP** — point your agent at:
52+
**Option C — Run the whole platform locally:**
4053

54+
```bash
55+
bun install
56+
bun run dev
4157
```
42-
https://www.superagentskill.com/api/mcp
43-
```
44-
45-
The hosted version is continuously evaluated and patched by SkillForge, so you always get the strongest variant.
4658

47-
## Contribute a package
59+
## The four building blocks
4860

49-
1. Fork this repo.
50-
2. Copy a template from `content/<type>/_template.yaml` into the same folder and rename it (`my-skill.yaml`).
51-
3. Fill it in. Validate locally:
52-
```bash
53-
bun install
54-
bun run validate:content
55-
```
56-
4. Open a pull request. CI runs the validator, and a maintainer reviews for quality, safety and overlap with existing packages.
61+
| | What it is | Use it when… |
62+
| --- | --- | --- |
63+
| 🛠 **Skills** | A focused capability with system prompt, rules, examples and a runnable input → output contract | You want the agent to *do one thing* very well (review code, write SQL, summarize a meeting). |
64+
| 📘 **Playbooks** | A multi-step decision graph that orchestrates skills + tools | The task has a recurring shape (triage bug → reproduce → propose fix → open PR). |
65+
| 🎭 **Souls** | A persona / value bundle — voice, taste, defaults — that wraps any agent | You need a consistent brand, tone or worldview across all tasks. |
66+
| 🛡 **Guardrails** | Refusal, safety and compliance policies enforced before output | You ship to real users and need hard "must / must not" rules. |
5767

58-
Detailed rules are in [CONTRIBUTING.md](CONTRIBUTING.md). Please also read the [Code of Conduct](CODE_OF_CONDUCT.md).
68+
Each one is a single self-contained YAML file. **Read it, fork it, ship it.**
5969

60-
## Run the platform locally
70+
```
71+
content/
72+
├── skills/ → Single capabilities
73+
├── playbooks/ → Multi-step workflows
74+
├── souls/ → Personas and values
75+
├── guardrails/ → Safety and compliance
76+
└── schemas/ → JSON Schemas (every package validates against these)
77+
```
6178

62-
The app is a TanStack Start + Lovable Cloud project.
79+
## Ship your first skill in 4 steps
6380

6481
```bash
65-
bun install
66-
bun run dev
82+
# 1. Fork & clone
83+
git clone git@github.com:<you>/agent-evolve-network.git
84+
cd agent-evolve-network && bun install
85+
86+
# 2. Start from a template
87+
cp content/skills/_template.yaml content/skills/my-killer-skill.yaml
88+
89+
# 3. Validate locally (same script CI runs)
90+
bun run validate:content
91+
92+
# 4. Open a PR — a maintainer reviews within 72h
6793
```
6894

69-
You will need a Lovable Cloud project (Supabase) — see [`supabase/`](supabase) for the schema. The marketplace UI, MCP endpoint, SkillForge loop and admin tools all live in [`src/`](src).
95+
A merged skill is automatically imported into the hosted registry, where **SkillForge starts evolving it against adversarial benchmarks** and serving the best variant through MCP to every connected agent on day one.
96+
97+
➡️ Full quality bar in [**CONTRIBUTING.md**](CONTRIBUTING.md).
98+
99+
## Why contribute?
100+
101+
Your work isn't just merged — it's *amplified*.
102+
103+
- 🌐 **Reach.** Every accepted package is served live through MCP to thousands of agents.
104+
- 🏆 **Reputation.** Public **Trust Score**, model compatibility matrix and leaderboard rankings on the [marketplace](https://www.superagentskill.com/marketplace/rankings).
105+
- 💸 **Revenue share.** Premium packages earn 80–85% of sales + recurring usage bonuses.
106+
- 🤖 **AI co-author.** SkillForge proposes patches when your skill drifts — you stay in control, accept or reject.
107+
- 🪪 **CVE-style credit.** Robustness findings (e.g. `SAS-2026-0001`) are publicly attributed.
108+
109+
> **First-time contributor?** Look for [`good first issue`](https://github.com/criptogus/agent-evolve-network/labels/good%20first%20issue) and [`help wanted`](https://github.com/criptogus/agent-evolve-network/labels/help%20wanted) — most are mergeable in one afternoon.
110+
111+
## What makes this different
112+
113+
| | Super Agent Skill | A prompt library on GitHub | A walled-garden GPT store |
114+
| --- | :---: | :---: | :---: |
115+
| Open content (CC BY-SA) ||||
116+
| Schema-validated quality bar ||| ⚠️ opaque |
117+
| Works in *any* MCP agent || ⚠️ manual paste | ❌ single vendor |
118+
| Continuous adversarial evolution ||||
119+
| Public trust + compatibility scores ||||
120+
| Revenue share for authors ||| ⚠️ limited |
70121

71122
## Roadmap
72123

73-
- [ ] CLI to scaffold and publish packages straight from the terminal
74-
- [ ] Content signing so consumers can verify a package version
75-
- [ ] Versioned releases of the registry as downloadable bundles
76-
- [ ] Public leaderboard for the highest-scoring community packages
124+
- [x] MCP server with discover / install / evaluate / report-execution tools
125+
- [x] SkillForge evolution loop (eval → patch → re-score)
126+
- [x] Public **Trust Score**, model compatibility matrix, drift detection
127+
- [ ] CLI (`npx sas init`, `sas publish`, `sas eval`)
128+
- [ ] Cryptographically signed package releases
129+
- [ ] Versioned downloadable registry bundles
130+
- [ ] Community-curated **collections** (curated bundles around a use case)
131+
132+
Track everything on the [public board](https://github.com/criptogus/agent-evolve-network/projects).
133+
134+
## Community
135+
136+
- 💬 **Discord**[join here](https://www.superagentskill.com/community) for help, design reviews, and weekly skill-jam events.
137+
- 🐦 **X / Twitter**[@superagentskill](https://twitter.com/superagentskill) for releases and benchmarks.
138+
- 📰 **Changelog** — every accepted package is announced in [GitHub Releases](https://github.com/criptogus/agent-evolve-network/releases).
139+
- 🛡 **Security** — please disclose responsibly via [SECURITY.md](SECURITY.md).
77140

78141
## License
79142

80-
- **Code** in this repo: [Apache License 2.0](LICENSE)
81-
- **Content** in `content/`: [Creative Commons Attribution-ShareAlike 4.0](LICENSES/CONTENT-CC-BY-SA-4.0.txt)
143+
- **Code** (this repo, outside `content/`): [Apache License 2.0](LICENSE)
144+
- **Content** (everything in `content/`): [Creative Commons Attribution-ShareAlike 4.0](LICENSES/CONTENT-CC-BY-SA-4.0.txt)
145+
146+
By contributing you agree your work is licensed under the same terms — and that it gets to make millions of agent conversations a little smarter every day.
147+
148+
---
149+
150+
<div align="center">
82151

83-
By contributing you agree your contribution is licensed under the same terms.
152+
**Built by makers, for makers. Star the repo ⭐ if you believe agents should belong to everyone.**
153+
154+
</div>

content/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Each package is a single YAML file. Filename = `<slug>.yaml`.
2929

3030
```bash
3131
# raw download
32-
curl -O https://raw.githubusercontent.com/<org>/super-agent-skill/main/content/skills/code-reviewer.yaml
32+
curl -O https://raw.githubusercontent.com/criptogus/agent-evolve-network/main/content/skills/code-reviewer.yaml
3333

3434
# or stream the live, evolving version through MCP
3535
# https://www.superagentskill.com/api/mcp

0 commit comments

Comments
 (0)