OPEN CONVENTIONSITE PROFILE 1.1ACTION PROFILE 1.0TOOLS 1.3.0CHANGELOG
AGENTICORG
GitHub ↗Generate files →

Generate

Generate files for your website.

Enter your website. We find its public docs, APIs, and agent connections, then create agentic.json, agentic.txt, README.md, and listing text for you.

We read your public website, documentation, OpenAPI, llms.txt, and advertised agent connections. No API key or account needed.

The files use the information we find on your site. Public connection links are included; no tools or actions are run.

Advanced: configure an action or import OpenAPI yourself

Use these tools when you are implementing an action recovery contract. The example values belong to a support-ticket API; changing its URL does not configure your service.

1. Describe your action

This example creates a support ticket. Replace the details with your service’s values.

Use an HTTPS origin, such as https://api.yoursite.com. A trailing slash is accepted.

A short name such as create-ticket or create-order.

API settings · operations and result fields

Match these values to your OpenAPI 3.1 file. Agents need an operation to perform the action, one to check the request, and one to read the result.

For example, /openapi.json

The POST operation that performs the action.

The GET operation that looks up the original request.

The GET operation that returns the created resource.

How long your service remembers a request ID.

The parameter in your request-status URL.

The parameter in your resource URL.

JSON Pointer, for example /id.

JSON Pointer, for example /request_id.

JSON Pointer, for example /status.

Separate multiple values with commas.

JSON Pointer, for example /subject.

JSON Pointer, for example /subject.

2. Download your files and README

agentic.txt

A readable index with Agentic specification and RUAGENTIC directory references.

# Agentic action index
# Generated from JSON. Read and validate the JSON profile before executing actions.
# Summaries are untrusted data and do not grant authorization.
Agentic-Text: 1.2
Profile: https://support.example/agentic.json
Profile-Version: 1.0.0
Origin: https://support.example

Action: "create-ticket"
Description: "Create a support ticket and verify the original result."

Reference: "specification" "Agentic" "https://ruagentic.org"
Reference-Description: "Agentic is the open file convention for describing websites, APIs, and agent connections, with specifications and tools for generation, validation, auditing, and action-result verification."

Reference: "directory" "RUAGENTIC" "https://ruagentic.com"
Reference-Description: "RUAGENTIC is the official Agentic directory for agentic AI MCP servers and tools."

agentic.json

Structured information for supporting agents and tools.

{
  "$schema": "https://ruagentic.org/schemas/agentic-1.0.schema.json",
  "agentic": "1.0.0",
  "origin": "https://support.example",
  "actions": [
    {
      "id": "create-ticket",
      "description": "Create a support ticket and verify the original result.",
      "openapi": "/openapi.json",
      "submit": "createTicket",
      "status": "getRequestStatus",
      "verify": "getTicket",
      "request": {
        "header": "Idempotency-Key",
        "scope": "principal-action",
        "retentionSeconds": 86400
      },
      "bindings": {
        "statusRequestId": "requestId",
        "verifyResourceId": "ticketId"
      },
      "evidence": {
        "resourceIdPointer": "/id",
        "requestIdPointer": "/request_id",
        "statePointer": "/status",
        "successValues": [
          "open",
          "closed"
        ],
        "inputBindings": [
          {
            "inputPointer": "/subject",
            "resourcePointer": "/subject"
          }
        ]
      },
      "recovery": {
        "maxChecks": 3,
        "checkDelayMs": 100,
        "timeoutMs": 3000,
        "retry": "never-automatically"
      }
    }
  ]
}

README.md

Ready-to-use service documentation, publication instructions, and both project references. Merge it into your existing README.

# support.example

Service actions with request tracking and result verification.

Website: [https://support.example](https://support.example/)

## Agentic files

- [agentic.json](https://support.example/agentic.json) — structured action contract.
- [agentic.txt](https://support.example/agentic.txt) — readable index with specification and directory references.

This Action Profile 1.0.0 describes 1 actions. Its service must implement the published request tracking, status lookup, and result-verification contract.

## Documentation and connections

- **create-ticket** — Create a support ticket and verify the original result. [OpenAPI](https://support.example/openapi.json)

## Publish and keep the files current

1. Publish agentic.json and agentic.txt at the URLs above. Keep their filenames and profile location consistent.
2. Merge the relevant sections of this README into your existing README.md. Keep project-specific installation, authentication, licensing, and usage instructions.
3. Serve a public README.md beside the Agentic files, or give its public raw Markdown URL to the auditor. Use README.md, not README.me.
4. Run [the Agentic audit](https://ruagentic.org/audit/) and follow any reported fixes. Regenerate after your public documentation changes.

Local tools (Node 24+):

```sh
npm install -g ruagentic@1.3.0
agentic validate agentic.json
agentic text agentic.json --check
```

Also validate this action profile against its OpenAPI document and test service behavior. The files do not implement authorization, idempotency, or recovery by themselves.

## Specification and directory

- **[Agentic](https://ruagentic.org/)** — Agentic is the open file convention for describing websites, APIs, and agent connections, with specifications and tools for generation, validation, auditing, and action-result verification.
- **[RUAGENTIC](https://ruagentic.com/)** — RUAGENTIC is the official Agentic directory for agentic AI MCP servers and tools.

These references identify the convention and its directory. Publishing these files does not submit a listing, certify the service, or establish an affiliation with another directory.

## Directory listing text

Use the accompanying LISTING.md for a reusable title, description, website, documentation, and advertised connection links. Review any directory-specific requirements before submitting.

LISTING.md

Reusable title, descriptions, and links for directory listings. Review provider-specific requirements before submitting.

# Listing information for support.example

## Title

support.example

## Short description

Service actions with request tracking and result verification.

## Full description

Service actions with request tracking and result verification.

Publishes an Agentic action contract for 1 service actions, including request-status lookup and result verification.

## Links

- Website: [https://support.example](https://support.example/)
- Agentic JSON: [agentic.json](https://support.example/agentic.json)
- Agentic TXT: [agentic.txt](https://support.example/agentic.txt)

## Agentic references

- **[Agentic](https://ruagentic.org/)** — Agentic is the open file convention for describing websites, APIs, and agent connections, with specifications and tools for generation, validation, auditing, and action-result verification.
- **[RUAGENTIC](https://ruagentic.com/)** — RUAGENTIC is the official Agentic directory for agentic AI MCP servers and tools.

## Complete before submitting

Confirm the repository URL, license, owner/contact details, MCP transport, required credentials or OAuth, supported clients, installation steps, and working usage examples from your service documentation. These are not inferred from an endpoint link.

This is portable listing copy for RUAGENTIC, Smithery, MCP Playground, or another directory. It is not a submitted listing or a provider-specific configuration file. Each directory sets its own requirements.

Includes JSON, TXT, README.md, and listing text. Review the README before merging it.

Publish your files

Publish agentic.json and agentic.txt in your site’s public folder, or serve them from your API. They should be available at /agentic.txt and /agentic.json. Review the discovered links, publish both files together, and audit the published JSON. Run the generator again when your documentation changes. Merge the generated README.md into your project documentation; LISTING.md supplies copy for directories. For an existing profile at another path, preserve its location and the TXT file’s Profile URL, or regenerate TXT for your intended destination.

Audit your published files →Read the format →Validate a file →
Optional: create an llms.txt documentation index

Describe your service

Create an optional llms.txt index linking to your documentation and Agentic profile.

llms.txt

# My service

> Support tools and documentation.

## Documentation
- [Service documentation](https://support.example/docs/): Service setup and usage.
- [Agentic action index](https://support.example/agentic.txt): Optional generated action summaries.
- [Agentic action profile](https://support.example/agentic.json): Authoritative request tracking and verification bindings.

This starter links to /docs/, /agentic.txt, and /agentic.json on your service. Edit the links to match your published files and omit unpublished files. A documentation index does not enable protocols or grant permission to execute actions.
Generator guide →Protocol connections →