Quickstart

Get AgentDoor running in under 10 minutes.

Install the SDK, mount middleware, and publish a machine-readable capability surface.

1. Install

Claim your baseline integration.

npm install @agentdoorio/sdk @agentdoorio/express

2. Mount

Expose capability routes and discovery.

import express from "express";
import { AgentDoor, search, browse, detail } from "@agentdoorio/sdk";

const app = express();
app.use(express.json());

const door = new AgentDoor({
  site: { name: "Example API", url: "https://api.example.com" },
  capabilities: [
    search({ handler: async (q) => db.search(q) }),
    browse({ handler: async (opts) => db.list(opts) }),
    detail({ handler: async (id) => db.getById(id) })
  ],
  rateLimit: 60,
  sessionTtl: 1800
});

app.use(door.middleware());
app.listen(3000);

3. Verify

Confirm your service is discoverable.

Discovery

agents.json

Check /.well-known/agents.json for machine-readable capabilities and session policy.

Policy

ai.txt

Publish optional AI policy to declare usage rules for agents and model clients.

Runtime

Capabilities

Exercise typed routes under /.well-known/agents/api/* with sessions and rate limits.