io.github.pooriaarab/aigentify
Audit and generate agent-native product surfaces
Open source Open in the app JSON README (API)
About
Audit and generate agent-native product surfaces
Details
- Kind
- MCP servers
- Topic
- No topic detected
- Publisher
- pooriaarab
- Origin
- official
- Category
- ferramentas
- Transport
- local
- Version
- 0.1.2
- Last push
- 2026-09-04T00:09:45Z
- Repository state
- ativo
- Language
- TypeScript
- License
- MIT
- Added
- 2026-08-29 04:01:12
- Updated
- 2026-08-29 04:01:12
- Origin id
io.github.pooriaarab/aigentify
README
# aigentify
aigentify audits a product directory or live URL for agent-native readiness. It also creates the public artifacts that agents can use.
## Install
```sh
npm install aigentify
```
## Three faces
Use the library in JavaScript or TypeScript:
```ts
import { auditTarget, generate } from 'aigentify';
const report = await auditTarget('.');
const instructions = generate('agents-md', {
name: 'Example product',
description: 'A product with a clear agent interface.',
repository: 'https://github.com/example/product',
});
```
Use the CLI:
```sh
npx aigentify audit .
npx aigentify gen agents-md
npx aigentify gen server-json --out server.json
```
Use the MCP server with an MCP client:
```sh
npx aigentify-mcp
```
The MCP server exposes `audit` with `{ target }` and `gen` with `{ artifact, params }`.
## Commands
- `aigentify audit [target]` checks a directory or URL. The default target is `.`.
- `aigentify init` writes starter `AGENTS.md` and `server.json` files. Existing files stay unchanged.
- `aigentify gen <artifact>` prints an artifact or writes it with `--out`.
- `aigentify mcp` starts the stdio MCP server.
Artifacts are `agents-md`, `server-json`, `offer`, and `agents-route`.
## Checks
`audit` scores these signals. The core signals work for a directory or a URL; the
web signals are only meaningful for a served URL and are marked `na` otherwise.
Core: `agents-md`, `agents-md-public-safe`, `server-json`, `mcp`, `offer-jsonld`,
`honest-offer`, `llms-txt`, `sitemap`.
Web (URL targets): `well-known-agent`, `openapi`, `agents-page`, `soft-404`
(unknown paths must return a real 404, not a 200 app shell), `markdown-negotiation`
(serve `text/markdown` on `Accept: text/markdown` with `Vary: Accept`),
`content-without-js` (an `<h1>` and 500+ characters without JS), `org-schema`
(Organization JSON-LD with `contactPoint` and `address`), `crawler-reachable`
(agent User-Agents can reach the homepage), and `rate-limit-headers` (standard
`RateLimit-*` headers), plus `auth-md`, `api-catalog` (RFC 9727),
`agent-card-a2a` (A2A), `link-headers` (RFC 8288), `markdown-alt`, plus **external-discovery** checks that query third-party registries — `ai-plugin`, `wikidata` (P856 official-website match), `npm-package`, and `mcp-registry`.
## Configuration
Add an optional `aigentify.config.ts`, `aigentify.config.js`, or `aigentify.config.mjs` file. Export `defineConfig(...)` data as the default export or as `aigentifyConfig`.
```ts
import { defineConfig } from 'aigentify';
export default defineConfig({
name: 'Example product',
description: 'A product with a clear agent interface.',
repository: 'https://github.com/example/product',
npmPackage: 'example-product',
offer: { name: 'Access', price: 0, priceCurrency: 'USD' },
});
```
## License
MIT