# Agent Interface Discovery (`rustic_soybean/agent-interface-discovery`) Actor

Check websites for public files useful to AI agents and developers, including robots.txt, llms.txt, and OpenAPI descriptions. Receive a structured report showing what was found and a summary of the site's published crawler rules.

- **URL**: https://apify.com/rustic_soybean/agent-interface-discovery.md
- **Developed by:** [Chris Johnson](https://apify.com/rustic_soybean) (community)
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.00 / 1,000 results

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Agent Interface Discovery

Agent-facing, structured discovery of public machine-readable site interfaces. Given up to 20 public HTTPS domains, inspect `robots.txt`, `llms.txt`, `llms-full.txt`, `/.well-known/openapi.json`, and `/openapi.json` without following redirects. Returns one JSON dataset record per domain with HTTP statuses, policy summary for a selected user-agent token, llms.txt links, OpenAPI metadata, and timestamps. It does **not** crawl pages, bypass robots rules, authenticate, or claim that an endpoint is usable without testing.

### Input

```json
{"domains":["https://example.com"],"userAgent":"GPTBot"}
```

### Buyers / uses

AI-agent developers, retrieval pipeline builders, integration catalog maintainers and documentation auditors can discover whether a site advertises agent-readable docs and API specifications. Outputs are deterministic and useful as an agent tool response. No LLM API cost.

### Security and limitations

Only public HTTPS hostnames, no IP literals, private DNS results rejected, redirects not followed, 12-second timeout per resource, 250 KB maximum per response. Public DNS may change between resolution and fetch; deploy behind egress restrictions for strong SSRF protection. `robots.txt` is a path-specific directive, not a blanket authorization; returned root policy is only a summary. Missing files are reported as HTTP statuses, not treated as errors. No automatic paid runs.

### Availability

This repository contains Actor source code. It is separate from an Apify Store listing; verify current Store availability before trying to run it.

### Run-to-run change detection

The first run for a domain and user-agent establishes a private baseline in the Actor's key-value store. Later runs report changes to robots rules, llms.txt headings and links, OpenAPI metadata and endpoint paths, resource availability, and llms-full.txt fingerprints. OpenAPI paths are capped at 100 and robots rules at 200 in each result to keep output bounded. Failed all-resource checks do not replace a prior baseline.

# Actor input Schema

## `domains` (type: `array`):

Public HTTPS websites to inspect. No credentials or internal hosts.

## `userAgent` (type: `string`):

Token to inspect in robots.txt; this does not assert permission to crawl.

## Actor input object example

```json
{
  "domains": [
    "https://example.com"
  ],
  "userAgent": "GPTBot"
}
```

# Actor output Schema

## `results` (type: `string`):

Public interface checks and detected changes for each domain.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {};

// Run the Actor and wait for it to finish
const run = await client.actor("rustic_soybean/agent-interface-discovery").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {}

# Run the Actor and wait for it to finish
run = client.actor("rustic_soybean/agent-interface-discovery").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{}' |
apify call rustic_soybean/agent-interface-discovery --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,rustic_soybean/agent-interface-discovery"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/vvz6lkI4lQuvOdeTR/builds/jQD2MFmhAqYxOobET/openapi.json