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
The name of the repository or service.
A brief description of what the repository or service does.
The version number of the service or API (e.g., “1.0.0”, “0.2.2”).
A description of how agents should identify themselves when using this service.
An array of capabilities that agents can use. Show Capability properties
The name of the capability (e.g., “create_task”, “search_documents”).
A detailed description of what the capability does.
JSON Schema describing the expected input parameters.
JSON Schema describing the output format.
An array of example usage strings demonstrating how to use the capability.
An array of HTTP endpoints available in the service. The URL path for the endpoint (e.g., “/api/tasks”, “/health”).
The HTTP method (e.g., “GET”, “POST”, “PUT”, “DELETE”).
A description of what the endpoint does.
An array of parameters accepted by the endpoint. Show Parameter properties
The data type of the parameter (e.g., “string”, “number”, “boolean”).
Whether the parameter is required.
A description of what the parameter does.
Authentication requirements for using the service. Show Authentication properties
The authentication type (e.g., “bearer”, “api_key”, “oauth2”, “none”).
Additional details about the authentication mechanism.
Rate limiting information for the service. Show RateLimits properties
Maximum number of requests allowed per minute.
Maximum number of requests allowed per day.
Additional notes about rate limiting policies.
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:
Generated by AI providers when processing a RepoContext
Serialized to create the structured sections of an AGENTS.md file
Parsed when validating existing AGENTS.md files
Used by agents to discover and interact with repository capabilities