Visual feedback tool for AI coding agents
Project description
Agentation
Visual feedback tool for AI coding agents. Adds a floating toolbar to your web application that displays structured page information optimized for AI consumption.
Installation
pip install agentation
With framework-specific extras:
pip install agentation[flask]
pip install agentation[fastapi]
Quick Start
Flask
from flask import Flask
from agentation import AgentationFlask
app = Flask(__name__)
AgentationFlask(app) # Auto-enabled when app.debug=True
See the Flask Guide for complete documentation.
FastAPI
from fastapi import FastAPI
from agentation import AgentationMiddleware, AgentationConfig
app = FastAPI()
config = AgentationConfig(enabled=True)
app.add_middleware(AgentationMiddleware, config=config)
See the FastAPI Guide for complete documentation.
Configuration
All options can be passed to AgentationConfig:
| Option | Type | Default | Description |
|---|---|---|---|
enabled |
bool | None |
None |
Enable toolbar. If None, uses env var or debug mode |
default_detail |
str |
"standard" |
Detail level: compact, standard, detailed, forensic |
default_format |
str |
"markdown" |
Output format: markdown, json |
position |
str |
"bottom-right" |
Toolbar position: bottom-right, bottom-left, top-right, top-left |
theme |
str |
"auto" |
Color theme: auto, light, dark |
accent_color |
str |
"#3b82f6" |
Accent color (hex) |
keyboard_shortcut |
str |
"ctrl+shift+a" |
Keyboard shortcut to toggle output |
block_interactions |
bool |
True |
Block page interactions while panel is open |
auto_clear_on_copy |
bool |
False |
Clear output after copying |
include_route |
bool |
True |
Include route info in output |
Enabling
Agentation uses the following precedence to determine if it's enabled:
- Explicit
enabledconfig option AGENTATION_ENABLEDenvironment variable (true/1/yesorfalse/0/no)- Framework debug mode (e.g.,
app.debugin Flask) - Default: disabled
Output Formats
Markdown (default)
Structured text optimized for AI agents to understand page structure:
- Compact: Minimal output with key elements only
- Standard: Balanced detail with headings, forms, and main content
- Detailed: Full page structure including all interactive elements
- Forensic: Complete DOM analysis for debugging
JSON
Machine-readable structured data with the same detail levels.
Keyboard Shortcut
Press Ctrl+Shift+A (configurable) to toggle the output panel. This copies structured page information to your clipboard, ready for pasting into an AI coding assistant.
Development
uv venv
uv pip install -e ".[dev]"
pytest
Credits
Python port of Agentation by Benji Taylor.
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agentation-0.1.0.tar.gz.
File metadata
- Download URL: agentation-0.1.0.tar.gz
- Upload date:
- Size: 72.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a4eb59ccf663e0cfb4acef2cce339113588fbe8c35f90ae82a293ed9b1d6b4c1
|
|
| MD5 |
0c3fce25a827a6d340c0e9a4d406a5f9
|
|
| BLAKE2b-256 |
83641262dc10b76fdfddb1133a0d50bb9901c6394652fca0e7018b4bdd3e76d6
|
File details
Details for the file agentation-0.1.0-py3-none-any.whl.
File metadata
- Download URL: agentation-0.1.0-py3-none-any.whl
- Upload date:
- Size: 17.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7eaff8c326bf84fb0962ce29ea0a41c854f93c77e7a487ee14a2076fa5846bc3
|
|
| MD5 |
b39d7f3f66207dc1d56066b4e657e49e
|
|
| BLAKE2b-256 |
998a4ed3a16f7fee2dec52ff4a346e1db8fdf8d76430603ce439526f6ee3d5b4
|