DRAFT GUIDANCE - NO PUBLIC ADAPTER YET

Website and Web API Flows

Web integrations can use MCP-AQL as a stable command layer for retrieval, extraction, and structured actions across HTTP-facing systems.

This is conceptual guidance. A public website/web API adapter reference is not published yet.

On this page

Jump to a section

Use the outline to move through longer pages without losing your place.

  1. When this pattern fits
  2. Design Guidance
  3. Conceptual Example
  4. Implementation Reference

Related reading

When this pattern fits

Best fit

  • The source surface mixes retrieval, parsing, and action execution across web pages or HTTP-facing APIs.
  • You want a stable contract above browser automation, scraping, or site-specific workflow code.
  • Field selection and clear read versus execute boundaries are important for cost and safety.

Watch for

  • Read flows and state-changing actions being blurred into one generic operation surface.
  • Fragile selectors or page-specific assumptions leaking into operation semantics.
  • HTTP, page, and workflow failures that need better structured error normalization.

Design Guidance

Read-Oriented Workflows

  • Model fetch and parse operations as explicit READ actions.
  • Document expected response shapes through introspection.
  • Use field-selection patterns to reduce payload size.

Action-Oriented Workflows

  • Use EXECUTE operations for actions with side effects.
  • Gate destructive web actions with confirmation requirements.
  • Map HTTP failures to protocol-level structured errors.

Conceptual Example

{
  "operation": "get_page_summary",
  "params": {
    "url": "https://mcpaql.org",
    "format": "markdown"
  }
}

Implementation Reference

Development Guide

Turn mixed retrieval and action workflows into explicit READ and EXECUTE operations with clearer contracts.

Testing Guide

Validate selector-driven flows, action boundaries, and error normalization before exposing web-facing operations.

Plugin System

Use plugin composition to isolate transport, auth, serialization, and transformation concerns in web integrations.