|
1 | 1 | --- |
2 | 2 | name: agentify |
3 | | -description: Transform any OpenAPI spec into 9 agent interface formats (MCP Server, CLAUDE.md, AGENTS.md, .cursorrules, Skills, llms.txt, GEMINI.md, A2A Card, CLI) |
| 3 | +description: Transform any OpenAPI spec into agent-consumable formats — MCP Server, CLAUDE.md, AGENTS.md, .cursorrules, Skills, llms.txt, GEMINI.md, A2A Card, CLI |
4 | 4 | --- |
5 | 5 |
|
6 | | -You are helping the user transform an OpenAPI specification into agent interface formats using Agentify. |
| 6 | +Help the user make their API accessible to AI agents using Agentify. |
7 | 7 |
|
8 | | -## Steps |
| 8 | +## What You Should Do |
9 | 9 |
|
10 | | -1. Ask the user for the OpenAPI spec URL or file path if not provided |
11 | | -2. Determine which formats to generate (default: all 8 standard formats, CLI is opt-in) |
12 | | -3. Run the transform command: |
| 10 | +When the user asks you to make their API agent-accessible, generate agent interfaces, set up MCP, or anything related to converting an API for agent consumption: |
13 | 11 |
|
14 | | -```bash |
15 | | -npx agentify-cli transform <input> [options] |
16 | | -``` |
| 12 | +1. **Find the OpenAPI spec** — ask the user for the path or URL. If they point to a project directory, look for `swagger.json`, `openapi.json`, `openapi.yaml`, or similar files. |
17 | 13 |
|
18 | | -### Options |
| 14 | +2. **Run the transform**: |
| 15 | + ```bash |
| 16 | + npx agentify-cli transform <spec-path-or-url> |
| 17 | + ``` |
19 | 18 |
|
20 | | -- `-o, --output <dir>` — Output directory (default: `<product-name>-mcp-server`) |
21 | | -- `-n, --name <name>` — Override project name |
22 | | -- `-f, --format <formats...>` — Select formats: mcp, claude.md, agents.md, cursorrules, skills, llms.txt, gemini.md, a2a, cli |
| 19 | +3. **Guide them through the output** — the tool generates a complete project directory with all agent interface formats. Walk them through `cd <output>`, `npm install`, configuring `.env`, and `npm start`. |
23 | 20 |
|
24 | | -### Available Formats |
| 21 | +## Common User Requests |
25 | 22 |
|
26 | | -| Format | Flag | What it generates | |
27 | | -|--------|------|-------------------| |
28 | | -| MCP Server | `mcp` | Full TypeScript server with tools, handlers, Dockerfile | |
29 | | -| CLAUDE.md | `claude.md` | Project context for Claude Code | |
30 | | -| AGENTS.md | `agents.md` | Universal agent instructions (Linux Foundation standard) | |
31 | | -| .cursorrules | `cursorrules` | Cursor IDE agent rules | |
32 | | -| Skills | `skills` | Structured capability file (skills.json) | |
33 | | -| llms.txt | `llms.txt` | LLM-readable condensed documentation | |
34 | | -| GEMINI.md | `gemini.md` | Gemini CLI project context | |
35 | | -| A2A Card | `a2a` | Google Agent-to-Agent discovery card | |
36 | | -| CLI | `cli` | Standalone command-line tool (opt-in, not in defaults) | |
| 23 | +| User says | What to do | |
| 24 | +|-----------|------------| |
| 25 | +| "Make my API work with Claude" | `npx agentify-cli transform <spec> -f mcp claude.md` | |
| 26 | +| "Generate agent interfaces for my product" | `npx agentify-cli transform <spec>` (all formats) | |
| 27 | +| "I need an MCP server for this API" | `npx agentify-cli transform <spec> -f mcp` | |
| 28 | +| "Create a CLI from my API spec" | `npx agentify-cli transform <spec> -f cli` | |
| 29 | +| "Set up agent access for Cursor/Copilot" | `npx agentify-cli transform <spec> -f agents.md cursorrules` | |
37 | 30 |
|
38 | | -## Examples |
| 31 | +## Options |
39 | 32 |
|
40 | | -```bash |
41 | | -# All default formats |
42 | | -npx agentify-cli transform https://petstore.swagger.io/v2/swagger.json |
43 | | - |
44 | | -# Only MCP server |
45 | | -npx agentify-cli transform ./api-spec.yaml -f mcp -o my-mcp-server |
46 | | - |
47 | | -# Generate a CLI tool |
48 | | -npx agentify-cli transform ./spec.json -f cli |
49 | | - |
50 | | -# Specific formats |
51 | | -npx agentify-cli transform ./spec.json -f mcp skills a2a |
52 | | -``` |
| 33 | +- `-o, --output <dir>` — where to write output (default: `<name>-mcp-server`) |
| 34 | +- `-n, --name <name>` — override project name |
| 35 | +- `-f, --format <formats...>` — pick specific formats: mcp, claude.md, agents.md, cursorrules, skills, llms.txt, gemini.md, a2a, cli |
53 | 36 |
|
54 | 37 | ## Supported Inputs |
55 | 38 |
|
56 | | -- Swagger 2.0 (JSON/YAML) |
57 | | -- OpenAPI 3.0.x / 3.1.x (JSON/YAML) |
58 | | -- URL or local file path |
59 | | - |
60 | | -## After Generation |
61 | | - |
62 | | -Guide the user through next steps: |
63 | | -1. `cd <output-dir>` |
64 | | -2. `npm install` |
65 | | -3. `cp .env.example .env` and configure API keys |
66 | | -4. `npm start` |
| 39 | +Swagger 2.0 or OpenAPI 3.x, JSON or YAML, URL or local file path. |
0 commit comments