Skip to content

Commit 14efb93

Browse files
committed
fix: Anthropic-style banner, restore README title, natural-language skill
- Redesign banner SVG: warm dark palette, minimal layout, clean monospace - Restore <h1>Agentify</h1> title in README, add flat-square badge style - Rewrite self/agentify.md as natural-language Claude Code skill with "Common User Requests" table for conversational interaction
1 parent 20eb517 commit 14efb93

4 files changed

Lines changed: 84 additions & 188 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
<div align="center">
22

3-
<img src="assets/banner.svg" alt="Agentify — Agent Interface Compiler" width="800">
3+
<h1>Agentify</h1>
4+
<p><strong>Agent Interface Compiler</strong> — One command. Every agent speaks your product.</p>
5+
6+
<img src="assets/banner.svg" alt="Agentify — OpenAPI to 9 agent interface formats" width="800">
47

58
<br>
69

7-
<a href="https://www.npmjs.com/package/agentify-cli"><img src="https://img.shields.io/npm/v/agentify-cli?color=cb3837&logo=npm" alt="npm"></a>
8-
<a href="https://github.com/koriyoshi2041/agentify/actions"><img src="https://img.shields.io/github/actions/workflow/status/koriyoshi2041/agentify/ci.yml?logo=github" alt="CI"></a>
9-
<a href="https://github.com/koriyoshi2041/agentify/blob/main/LICENSE"><img src="https://img.shields.io/github/license/koriyoshi2041/agentify" alt="MIT License"></a>
10-
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white" alt="TypeScript"></a>
10+
<a href="https://www.npmjs.com/package/agentify-cli"><img src="https://img.shields.io/npm/v/agentify-cli?color=cb3837&logo=npm&style=flat-square" alt="npm"></a>
11+
<a href="https://github.com/koriyoshi2041/agentify/actions"><img src="https://img.shields.io/github/actions/workflow/status/koriyoshi2041/agentify/ci.yml?logo=github&style=flat-square" alt="CI"></a>
12+
<a href="https://github.com/koriyoshi2041/agentify/blob/main/LICENSE"><img src="https://img.shields.io/github/license/koriyoshi2041/agentify?style=flat-square" alt="MIT License"></a>
13+
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white&style=flat-square" alt="TypeScript"></a>
1114

1215
</div>
1316

assets/banner.svg

Lines changed: 49 additions & 129 deletions
Loading

self/agentify.md

Lines changed: 23 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,39 @@
11
---
22
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
44
---
55

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.
77

8-
## Steps
8+
## What You Should Do
99

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:
1311

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.
1713

18-
### Options
14+
2. **Run the transform**:
15+
```bash
16+
npx agentify-cli transform <spec-path-or-url>
17+
```
1918

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`.
2320

24-
### Available Formats
21+
## Common User Requests
2522

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` |
3730

38-
## Examples
31+
## Options
3932

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
5336

5437
## Supported Inputs
5538

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.

test/self-describe.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ describe("Self-Description Files", () => {
2424
);
2525
const match = content.match(/description:\s*(.+)/);
2626
expect(match).not.toBeNull();
27-
expect(match![1]).toContain("agent interface formats");
27+
expect(match![1]).toContain("agent-consumable formats");
2828
});
2929

3030
it("contains the transform command usage", () => {
@@ -48,13 +48,13 @@ describe("Self-Description Files", () => {
4848
}
4949
});
5050

51-
it("includes examples section", () => {
51+
it("includes common user requests for natural interaction", () => {
5252
const content = fs.readFileSync(
5353
path.join(SELF_DIR, "agentify.md"),
5454
"utf-8",
5555
);
56-
expect(content).toContain("## Examples");
57-
expect(content).toContain("petstore.swagger.io");
56+
expect(content).toContain("## Common User Requests");
57+
expect(content).toContain("## What You Should Do");
5858
});
5959
});
6060

0 commit comments

Comments
 (0)