agentation README

The project's README from github.com/benjitaylor/agentation. As one markdown file: README.md.

Agentation

npm version downloads

Agentation is an agent-agnostic visual feedback tool. Click elements on your page, add notes, and copy structured output that helps AI coding agents find the exact code you're referring to.

Install

npm install agentation -D

Usage

import { Agentation } from 'agentation';

function App() {
  return (
    <>
      <YourApp />
      <Agentation />
    </>
  );
}

The toolbar appears in the bottom-right corner. Click to activate, then click any element to annotate it.

Connect to your agent

Copied feedback works with Claude Code, Codex, Gemini, Grok, or any AI tool. For direct sync, register npx -y agentation-mcp server with your MCP client and connect the toolbar to its HTTP endpoint:

<Agentation endpoint="http://localhost:4747" />

Keep the agent running, add a test annotation, and ask it to read the feedback. See the setup guide.

Features

See the package README for props and integration examples.

How it works

Agentation captures class names, selectors, and element positions so AI agents can grep for the exact code you're referring to. Instead of describing "the blue button in the sidebar," you give the agent .sidebar > button.primary and your feedback.

Requirements

Docs

Full documentation at agentation.com

License

© 2026 Benji Taylor

Licensed under PolyForm Shield 1.0.0

agentation (benjitaylor/agentation)

Searching Database…

这是什么?Agentation 是一款面向 AI 编程助手的可视化反馈工具:你可以点击网页上的元素、添加备注,然后复制结构化的输出内容,帮助 AI 助手准确找到你指的那段代码。
它是需要安装的浏览器扩展,还是要加到我应用里的库?是一个库:一个 npm 包,添加到你的 React 应用后,它的工具栏就渲染在你自己页面的右下角。不需要安装任何独立的应用或扩展,而且除了 React 的 peer dependencies 之外,不附带任何其他运行时依赖。
装到我的应用里之后,怎么使用?点击右下角的工具栏激活它,然后点击任意元素进行标注——选择器会自动识别。复制生成的 markdown,粘贴到你的 AI 助手里即可。
我的项目需要具备什么条件才能用它?项目里要有 React 18+,再用一个桌面浏览器来运行——除此之外什么都不需要。
可以在手机或平板上使用吗?不行——它必须在桌面浏览器里运行,不支持移动端,所以标注操作要在你开发的那个环境里进行。
它到底是给谁用的——开发者还是设计师?主要面向在网页 UI 上使用 AI 编程助手的开发者:也就是那些本来只能用文字描述"侧边栏里那个蓝色按钮",而没法让 AI 助手直接定位到具体元素的人。
它是采用宽松许可证的开源软件吗?不是——它采用的是 PolyForm Shield 1.0.0 许可证,而不是 MIT 或 Apache,所以在把自己的代码复用到你的产品里之前,请先阅读相关条款。
我可以把反馈发给哪些 AI 助手?任何一种都可以。复制出来的 markdown 就是普通的结构化文本,所以不管是 Claude Code、Codex、Gemini、Grok,还是任何你粘贴进去的 AI 工具,都能使用。如果想自动发送而不用手动复制粘贴,可以在你的 MCP 客户端里注册 agentation-mcp 服务器,并把工具栏连接到它的 HTTP 端点。
AI 助手是怎么根据我的标注找到确切代码的?复制出来的 markdown 包含 CSS 选择器、类名、元素位置以及上下文信息,这样 AI 助手就可以在你的代码库里精确搜索那个元素,而不是靠描述去猜。编辑器集成还能直接帮你打开定位到的源码位置。
除了点击单个元素,还能怎么标注?方式很多:可以选中文字、按住 Cmd/Ctrl 逐个选取元素、拖动进行多选,或者在空白区域拖出一块范围。你还可以暂停 CSS 动画、Web Animations 和视频,在标注前把某个状态定格住。
它在 shadow DOM 或 iframe 里也能用吗?可以——开放的 shadow root 和同源 iframe 里的元素都能选中。你还可以选择启用 hash 路由,让每个路由拥有各自独立的标注和会话,设置里还有深色/浅色模式切换。
Size
6.4 MB
Stars
5K
Age
9mo
Commits · 90 Days