agenticwebprotocol

v0.2.2

Published

3 months ago

AWP - Agentic Web Protocol

0High
0Medium
0Low

bluera-team

chris-bluera

This page aims to document Python protocols and usage (e.g. cloud, desktop).
Looking for Javascript/Typescript instructions?

Overview

The Agentic Web Protocol, or AWP, allows AI agents to reliably understand and interact with the web.

It is composed of two protocols, for web pages and APIs, allowing them to be usable by AI agents.

A standard Universal Tool is also provided, for AI agents to be able to instantly leverage AWP compliant pages and APIs.

🤖 Discoverable Websites and APIs, for AI Agents interactions. Bluera Inc.

Get Started

Learn more about how to support AWP, by clicking the most appropriate option for you:

Websites

See the AWP Protocol Specifications below, and familiarize yourself with the standard ai parameters
Add the appropriate ai parameters to your website.

🎉 Your website can be reliably used by any AI agent!

APIs

See the AWP Protocol Specifications below, and familiarize yourself with the standard /ai-handshake endpoint
Add the standard /ai-handshake endpoint to your API.

🎉 Your API can be reliably used by any AI agent!

See the AWP Tool below, and familiarize yourself with its parse_html and parse_api methods.
Add the AWP Tool to your AI Agent.

🎉 Your AI agent can now reliably use any AWP compliant websites or APIs!

Documentation

Protocol Specifications

Web pages

Introduction

The Challenge of Web Interactivity for AI Agents
Without information about what a web page is for, how it is structured, what features it provides, and how to interact with it, an AI agent has to figure out everything on its own.
This is commonly done through scrappers and/or vision models aimed at guessing what the agent sees.
Websites being diverse, complex, dynamic, Javascript-heavy and often moslty made of generic <div>s, this exercise commonly leads to unreliable parsing and broken/unintended interactions.
Intelligent agents need richer semantic hints to parse and interact with these pages reliably.

The premise of AWP is simple: include standard information in the HTML page itself, for any agent to be able to reliably understand and interact with it.

For an agent to so, the following information needs to be attached to meaninful and/or interactive HTML tags:

A description, for it to know what it is.
A list of possible interactions, for it to know what to do.
A list of prerequisites, for it to know what to do prior to interacting.
A list of subsequent features, for it to know what those interactions lead to.

Additional optional information such as states, or established accessibility parameters (eg. role, aria-*) may also be used to complement the agent's understanding of the page.

Contract

Let's start with a simple example. Your agent just found this website by crawling the web:

<html>
  <body>
    <form>
      This site uses cookies
      <button>Configure</button>
    </form>
    <form>
      <h1> Website name </h1>
      <label> What's next? </label>
      <input
        type="text"
        name="destination"
        required
        minlength="3"
        maxlength="30"/>
      <div>
        <button disabled> -> </button>
        <button> Back </button>
      </div>
    </form>
  </body>
</html>

It now needs to understand what it is for, to know if it can be used to answer your query, and if so, how to interact with it?

For all reasons described above, this often becomes a difficult and error-prone task —leading to unintended behaviors and imparing the agent's ability to act reliably on our behalf.

With AWP, this information is now declared in the HTML itself, through standard optional ai-* attributes.

<html ai-description="Travel site to book flights and trains">
  <body>
    <form>
      This site uses cookies
      <button>Configure</button>
    </form>
    <form ai-description="Form to book a flight">
      <h1>
        Website name
      </h1>
      <label>
        What's next?
      </label>
      <input
        ai-ref="<input-ai-ref>"
        ai-description="Form input where to enter the destination"
        ai-interactions="input: enables the form confirmation button, given certain constraints;"
        type="text"
        name="destination"
        required
        minlength="3"
        maxlength="30"/>
      <div>
        <button
          ai-description="Confirmation button to proceed with booking a flight"
          ai-interactions="click: proceed; hover: diplay additonal information about possible flights;"
          ai-prerequisite-click="<input-ai-ref>: input destination;"
          ai-next-click="list of available flights; book a flight; login;"
          disabled>
          ->
        </button>
        <button
          ai-description="Cancel button to get back to the home page"
          ai-interactions="click: dismiss form and return to home page;"
          ai-next-click="access forms to book trains; access forms to book flights;">
          Back
        </button>
      </div>
    </form>
  </body>
</html>

The web app can now be reliably understood and used by any AI agents 🙌

Standard Parameters

| Parameter | Description | Requirement | |--------|-------------|----------| | ai-description | A natural language description for agents to know what the element is | • Meaningful Element: required• Interactive Element: required• Other Element: absent | | ai-interactions | A list of possible interactions, for agents to know what to do with the elementFormat:<interaction>: <behavior>; <interaction>: <behavior>;.. | • Meaningful Element: absent• Interactive Element: required• Other Element: absent | | ai-prerequisite-<interaction> | A list of prerequisite interactions, for agents to know what to do prior to interacting with the elementFormat:<ai-ref>: <interaction>;.. | • Meaningful Element: absent• Interactive Element: optional• Other Element: absent | | ai-ref | A unique identifier for agents to know where those prerequisite interactions should be made | • Meaningful Element: absent• Interactive Element: optional• Other Element: absent | | ai-next-<interaction> | A list of subsequent features, for agents to know what those interactions lead toFormat:<next feature>; <next feature>;.. | • Meaningful Element: absent• Interactive Element: optional• Other Element: absent | | ai-state | A natural language description of the state the component is in | • Meaningful Element: optional• Interactive Element: optional• Other Element: optional |

An AWP Tool is also distributed by this library to allow any AI agent to reliably use AWP compliant websites.

APIs

Introduction

The Challenge of API Interactivity for AI Agents
Without information about what an API is for, how it is structured, what features it provides, and how to interact with it, an AI agent has to figure out everything on its own.
This is commonly passed manually as context, fetched via web crawlers attempting to find documentation online, or by spinning up additional middleware servers (eg. mcp) to allow them to be discoverable.

The premise of AWP is simple: include standard information in the API itself, for any agent to be able to reliably understand and interact with it, without requiring additional middleware servers to do so.

For an agent to know how to use any API, the following information needs to be discoverable:

A list of all each available endpoints on that API, to know what they are
A description for each endpoint, to know what they are for
meta information for each endpoint, to know how to access them
An input documentation for each endpoint, to know what to provide
An output documentation for each endpoint, to know what to expect

Contract

With AWP, the API documentation is made accessible on the API itself, with a standard /ai-handshake endpoint.

This allows AI agents to query /ai-handshake, get a complete description of the API, and know how to further interact with it.

For simplicity, and since it is a well established standard on the web, the AWP expects a OpenAPI compliant documentation to be returned by that endpoint.

Here is a simple example: https://editor.swagger.io

Standard Endpoint

| Path | Description | Type | Method | Input | Output | Requirement | |--------|--------------------------------|----------|----------|----------|----------|----------| | /ai-handshake | Standard endpoint returning a OpenAPI compliant documentation of the API which hosts the endpoint, excluding /ai-handshake, JSON or YAML based on headers | REST | GET | Headers:"Content-Type": "application/yaml"(recommended)or"Content-Type": "application/json" | OpenAPI compliant documentation, of requested Content-Type (eg. YAML, JSON, text) | required |

An AWP Tool is also distributed by this library to allow any AI agent to reliably use AWP compliant API.

AWP Tool

This project also shares a Universal Tool for your agents to be able reliably understand and interact with the AWP compliant Web pages and APIs.

For more information about Universal Tools, see ◉ Universal Intelligence

Installation

pip install awp

# (if using universal tool) Choose relevant UIN install for your device
pip install "universal-intelligence[community,mps]" # Apple
pip install "universal-intelligence[community,cuda]" # NVIDIA

Usage

Standard

import awp

# Get HTML documentation
html_doc = awp.parse_html(html)

# Get API documentation
api_doc = awp.parse_api(url)

| Method | Parameters | Return Type | Description | |--------|------------|-------------|-------------| | parse_html | • html: str: HTML page to parse• format: str \| None = "YAML": Output format | Any | Parses all AWP ai-* parameters on the page and returns a documentation in the requested format (YAML, JSON), usable by any AI agent to reliably understand and interact with that web page | | parse_api | • url: str: URL of the API to parse• authorization: str \| None = None: Authentication header if required• format: str \| None = "YAML": Output format | Any | Calls the standard /ai-handshake endpoint of that API and returns an OpenAPI compliant documentation of that API in the requested format (YAML, JSON), usable by any AI agent to reliably understand and interact with that API |

As Universal Tool

from awp import UniversalTool as AWP

# Get HTML documentation
html_doc, logs = AWP().parse_html(html)

# Get API documentation
api_doc, logs = AWP().parse_api(url)

| Method | Parameters | Return Type | Description | |--------|------------|-------------|-------------| | __init__ | • verbose: bool \| str = "DEFAULT": Enable/Disable logs, or set a specific log level | None | Initialize a Universal Tool | | parse_html | • html: str: HTML page to parse• format: str \| None = "YAML": Output format | Tuple[Any, Dict] | Parses all AWP ai-* parameters on the page and returns a documentation in the requested format (YAML, JSON), usable by any AI agent to reliably understand and interact with that web page | | parse_api | • url: str: URL of the API to parse• authorization: str \| None = None: Authentication header if required• format: str \| None = "YAML": Output format | Tuple[Any, Dict] | Calls the standard /ai-handshake endpoint of that API and returns an OpenAPI compliant documentation of that API in the requested format (YAML, JSON), usable by any AI agent to reliably understand and interact with that API | | (class).contract | None | Contract | Tool description and interface specification | | (class).requirements | None | List[Requirement] | Tool configuration requirements |

Example Output

Parse HTML

Input

<html ai-description="Travel site to book flights and trains">
  <body>
    <form 
      ai-description="Form to book a flight" 
      ai-state="pending"
      class="form-booking-flight">
      <h1>
        Book a flight
      </h1>
      <label>
        Where to?
      </label>
      <input
        ai-ref="<input-ai-ref>"
        ai-description="Form input where to enter the destination"
        ai-interactions="input: enables the form confirmation button, given certain constraints;"
        role="destination-input"
        aria-required="true"
        alt="destination input"
        type="text"
        id="destination"
        name="destination"
        required
        minlength="3"
        maxlength="30"
        size="10" />
      <div>
        <button
          ai-description="Confirmation button to proceed with booking a flight"
          ai-interactions="click: proceed; hover: diplay additonal information about possible flights;"
          ai-prerequisite-click="<input-ai-ref>: input destination;"
          ai-next-click="list of available flights; book a flight; login;"
          aria-disabled="true"
          disabled>
          See available flights
        </button>
        <button
          ai-description="Cancel button to get back to the home page"
          ai-interactions="click: dismiss form and return to home page;"
          ai-next-click="access forms to book trains; access forms to book flights;">
          Back
        </button>
      </div>
    </form>
  </body>
</html>

Output

elements:
- selector: html
  description: Travel site to book flights and trains
  contains:
  - selector: html body form.form-booking-flight
    description: Form to book a flight
    state: pending
    content: Book a flight Where to?
    contains:
    - selector: html body form.form-booking-flight input#destination[name='destination'][type='text'][role='destination-input']
      description: Form input where to enter the destination
      available_interactions:
      - type: input
        description: enables the form confirmation button, given certain constraints
      attributes:
        name: destination
        role: destination-input
        alt: destination input
        aria-required: 'true'
        maxlength: 30
        minlength: 3
        required: true
        type: text
    - selector: html body form.form-booking-flight div button
      description: Confirmation button to proceed with booking a flight
      content: See available flights
      available_interactions:
      - type: click
        description: proceed
        prerequisites:
        - selector: html body form.form-booking-flight input#destination[name='destination'][type='text'][role='destination-input']
          interaction: input destination
        next_features:
        - list of available flights
        - book a flight
        - login
      - type: hover
        description: diplay additonal information about possible flights
      attributes:
        aria-disabled: 'true'
    - selector: html body form.form-booking-flight div button:nth-of-type(2)
      description: Cancel button to get back to the home page
      content: Back
      available_interactions:
      - type: click
        description: dismiss form and return to home page
        next_features:
        - access forms to book trains
        - access forms to book flights

YAML (default) or JSON per requested format.
YAML recommended for improved token efficiency and stability.

Parse API

Input

GET https//example.api.com/ai-handshake

Output

OpenAPI compliant documentation, YAML (default) or JSON per requested format.

Example available here.

Tip: Tools like Swagger can automatically generate a OpenAPI compliant documentation for your API which you may serve at /ai-handshake. They usually also provide no-code UIs to display and interact wich that documentation on the web (eg. Swagger UI).

Playground

A ready-made playground is available to help familiarize yourself with the AWP protocols and tools.

# Install project dependencies
pip install -r requirements.txt 
# Choose relevant UIN install for your device
pip install "universal-intelligence[community,mps]" # Apple
pip install "universal-intelligence[community,cuda]" # NVIDIA

# Run
python -m playground.example

Cross-Platform Support

lng_icon The AWP tool can be used across all platforms (cloud, desktop, web, mobile).

Support

This software is open source, free for everyone, and lives on thanks to the community's support ☕

If you'd like to support to agentic-web-protocol here are a few ways to do so:

⭐ Consider leaving a star on this repository to support our team & help with visibility
👽 Tell your friends and collegues
📰 Support this project on social medias (e.g. LinkedIn, Youtube, Medium, Reddit)
✅ Adopt the AWP specification
💪 Use the AWP Tool
💡 Help surfacing/resolving issues
💭 Help shape the AWP specification
🔧 Help maintain, test, enhance the AWP Tool
✉️ Email us security concerns
❤️ Sponsor this project on Github
🤝 Partner with Bluera

License

Apache 2.0 License - Bluera Inc.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Overview

Get Started

Websites

APIs

Documentation

Protocol Specifications

Web pages

Introduction

The Challenge of Web Interactivity for AI Agents

Contract

Standard Parameters

APIs

Introduction

The Challenge of API Interactivity for AI Agents

Contract

Standard Endpoint

AWP Tool

Installation

Usage

Standard

As Universal Tool

Example Output

Parse HTML

Input

Output

Parse API

Input

Output

Playground

Cross-Platform Support

Support

License