Skip to content

Update readme #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
faction23 merged 1 commit into from
Aug 25, 2026
Merged

Update readme #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 4 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,17 @@ npx skills add gravityforms/gravityskills --skill gravity-forms-abilities

### GitHub Releases

Download skill zips directly from [Releases](https://github.com/gravityforms/gravityskills/releases) and extract into your project's `.agents/skills/` directory.
Download skill zips directly from [Releases](https://github.com/gravityforms/gravityskills/releases) and extract into your project's `.agents/skills/` directory (or other applicable directory, eg `.claude/skills`).

In the case of the Claude desktop app, follow their [instructions](https://support.claude.com/en/articles/12512180-use-skills-in-claude).

## Available Skills

### [`gravity-forms-abilities`](skills/gravity-forms-abilities/)

Workflow guidance for AI agents using Gravity Forms abilities via the WordPress Abilities API (MCP). Covers form CRUD, entry management, submissions, feeds, notifications, conditional logic, and system queries. Provides critical sequencing rules, field configuration knowledge, and pitfall avoidance that tool schemas alone cannot express.

**Requires:** WordPress site with Gravity Forms 2.9+ and MCP endpoint enabled (GF Settings → MCP).
**Requires:** WordPress site with Gravity Forms 3.1+ and MCP endpoint enabled (GF Settings → MCP).

```bash
npx skills add gravityforms/gravityskills --skill gravity-forms-abilities
Expand All @@ -40,38 +42,6 @@ npx skills add gravityforms/gravityskills --skill gravity-forms-abilities

Once installed, skills are automatically available to your AI coding agent. The agent reads the skill's `SKILL.md` when working on relevant tasks.

**Examples:**

```
Help me build a Gravity Forms integration
```

```
Review my form field implementation
```

## Skill Structure

Each skill contains:

- `SKILL.md` — Instructions for the agent (required)
- `references/` — Supporting documentation (optional)
- `scripts/` — Helper scripts for automation (optional)

## Contributing

Skills must follow the [Agent Skills spec](https://agentskills.io/):

- **Name**: lowercase, hyphens only, 1–64 characters
- **Directory name** must match the `name` field in `SKILL.md` frontmatter
- **Frontmatter**: `name` and `description` fields required

Run validation before submitting:

```bash
./scripts/validate-skills.sh
```

## License

GPL-2.0+
Loading