Skip to main content
The AgentsManifest model represents the parsed and structured content of an AGENTS.md file. It describes the capabilities, endpoints, and metadata that make a repository accessible to AI agents.

Fields

name
string
required
The name of the repository or service.
description
string
required
A brief description of what the repository or service does.
version
string | null
The version number of the service or API (e.g., “1.0.0”, “0.2.2”).
agent_identity
string | null
A description of how agents should identify themselves when using this service.
capabilities
array
default:"[]"
An array of capabilities that agents can use.
endpoints
array
default:"[]"
An array of HTTP endpoints available in the service.
authentication
object | null
Authentication requirements for using the service.
rate_limits
object | null
Rate limiting information for the service.
contact
string | null
Contact information for support or inquiries (email, URL, etc.).

Example

{
  "name": "TaskMaster API",
  "description": "A powerful task management API for organizing and tracking work",
  "version": "1.0.0",
  "agent_identity": "Agents should identify themselves via the X-Agent-Name header",
  "capabilities": [
    {
      "name": "create_task",
      "description": "Creates a new task in the system",
      "input_schema": {
        "type": "object",
        "properties": {
          "title": { "type": "string" },
          "priority": { "type": "string", "enum": ["low", "medium", "high"] }
        },
        "required": ["title"]
      },
      "output_schema": {
        "type": "object",
        "properties": {
          "id": { "type": "string" },
          "title": { "type": "string" }
        }
      },
      "examples": [
        "POST /tasks with {\"title\": \"Review PR\", \"priority\": \"high\"}"
      ]
    }
  ],
  "endpoints": [
    {
      "path": "/tasks",
      "method": "POST",
      "description": "Create a new task",
      "parameters": [
        {
          "name": "title",
          "type": "string",
          "required": true,
          "description": "The title of the task"
        },
        {
          "name": "priority",
          "type": "string",
          "required": false,
          "description": "Task priority level"
        }
      ]
    },
    {
      "path": "/health",
      "method": "GET",
      "description": "Health check endpoint",
      "parameters": []
    }
  ],
  "authentication": {
    "type": "bearer",
    "description": "Use Bearer token authentication with JWT tokens"
  },
  "rate_limits": {
    "requests_per_minute": 60,
    "requests_per_day": 10000,
    "notes": "Rate limits are per API key"
  },
  "contact": "[email protected]"
}

Usage

The AgentsManifest is:
  1. Generated by AI providers when processing a RepoContext
  2. Serialized to create the structured sections of an AGENTS.md file
  3. Parsed when validating existing AGENTS.md files
  4. Used by agents to discover and interact with repository capabilities

Build docs developers (and LLMs) love