Quick Start Guide¶

Fast track for using Agent Interface Discovery.

Package Overview¶

AID provides libraries and tools for multiple languages and use cases:

Package	Purpose	Language	Status
@agentcommunity/aid	Core discovery library	TypeScript	✅ Published
@agentcommunity/aid-doctor	CLI validation & generation	Node.js	✅ Published
aid-py	Python discovery library	Python	🔜 Published
aid-go	Go discovery library	Go	✅ Published
AID Web Workbench	Interactive generator & resolver	Web	🌐 Try it live

Part 1: For Providers (Publishing Your Agent)¶

Do you have an agent with an API endpoint? Let's make it discoverable. All you need is access to your domain's DNS settings.

Option A: Quick CLI Generation (Recommended)¶

The fastest way to get started is with our CLI tool:

# Install the CLI globally
npm install -g @agentcommunity/aid-doctor

# Generate a TXT record interactively
aid-doctor generate

# Or generate directly with flags
aid-doctor generate \
  --uri https://api.my-cool-saas.com/agent/v1 \
  --proto mcp \
  --desc "My Cool SaaS AI"

This outputs the exact TXT record content you need:

v=aid1;uri=https://api.my-cool-saas.com/agent/v1;p=mcp;desc=My Cool SaaS AI

Plus validation: The CLI automatically validates your record format, URI scheme, and protocol tokens before generating.

Option B: Manual Generation¶

If you prefer to craft the record manually:

Step 1: Gather Your Agent's Info¶

You need two things:

URI: The full URL to your agent's endpoint.
- Example: https://api.my-cool-saas.com/agent/v1
Protocol: The protocol it speaks. Let's assume mcp.
- Example: mcp

Step 2: Generate the TXT Record Content¶

The AID record is a single string of key=value pairs.

v=aid1;uri=https://api.my-cool-saas.com/agent/v1;p=mcp;desc=My Cool SaaS AI

Tip: Use our Live Generator to create this string and avoid typos!

Step 3: Add the Record to Your DNS¶

Go to your DNS provider (Cloudflare, Vercel, GoDaddy, etc.) and add a new TXT record.

Type: TXT
Name (or Host): _agent (for the domain my-cool-saas.com)
Content (or Value): The string from Step 2.
TTL: 300 (5 minutes) is a good starting point.

Step 4: Verify Your Record¶

Wait a few minutes for DNS to propagate. You can then check your work:

Using the CLI:

aid-doctor check my-cool-saas.com

Using command line tools:

# For Mac/Linux
dig TXT _agent.my-cool-saas.com

# For Windows
nslookup -q=TXT _agent.my-cool-saas.com

The output should show your record!

Part 2: For Clients (Discovering an Agent)¶

Now let's write code to find an agent. We provide libraries in several languages to make this trivial.

TypeScript / JavaScript¶

Install the library:

pnpm add @agentcommunity/aid

Then use the discover function:

import { discover } from '@agentcommunity/aid';

try {
  // Use a real, AID-enabled domain
  const { record, ttl } = await discover('supabase.agentcommunity.org');

  console.log('Discovery successful!');
  console.log(`  -> Protocol: ${record.proto}`); // "mcp"
  console.log(`  -> URI: ${record.uri}`); // "https://api.supabase.com/mcp"
  console.log(`  -> Description: ${record.desc}`); // "Supabase MCP"
} catch (error) {
  console.error(`Discovery failed: ${error.message}`);
}

Browser Support: For browser environments, use the DNS-over-HTTPS version:

import { discover } from '@agentcommunity/aid/browser';

const { record } = await discover('supabase.agentcommunity.org');
console.log(`Found ${record.proto} agent at ${record.uri}`);

Python¶

Install the library:

pip install aid-discovery

Then use the discover function:

from aid_py import discover, AidError

try:
    # Use a real, AID-enabled domain
    result = discover("supabase.agentcommunity.org")

    print("Discovery successful!")
    print(f"  -> Protocol: {result.record.proto}") # "mcp"
    print(f"  -> URI: {result.record.uri}") # "https://api.supabase.com/mcp"
    print(f"  -> Description: {result.record.desc}") # "Supabase MCP"

except AidError as e:
    print(f"Discovery failed: {e}")

📖 More Details: See the Python package README for advanced usage, error handling, and API reference.

Go¶

Install the library:

go get -u github.com/agentcommunity/agent-interface-discovery/aid-go

Then use the Discover function:

package main

import (
    "fmt"
    "log"
    "time"

    "github.com/agentcommunity/agent-interface-discovery/aid-go"
)

func main() {
    // Use a real, AID-enabled domain
    result, ttl, err := aid.Discover("supabase.agentcommunity.org", 5*time.Second)
    if err != nil {
        log.Fatalf("Discovery failed: %v", err)
    }

    fmt.Println("Discovery successful!")
    fmt.Printf("  -> Protocol: %s\n", result.Proto) // "mcp"
    fmt.Printf("  -> URI: %s\n", result.URI) // "https://api.supabase.com/mcp"
    fmt.Printf("  -> Description: %s\n", result.Desc) // "Supabase MCP"
    fmt.Printf("  -> TTL: %d seconds\n", ttl)
}

📖 More Details: See the Go package README for advanced usage, error handling, and API reference.

That's it! You now have the agent's URI and can proceed to connect to it using its specified protocol.

Explore: