WebAgent Vibecoding
如果你正在 IDE 里用 LLM 写代码——Cursor、Claude Code、Aider、Continue……——先把 WebAgent 完整文档和 OpenAPI schema 放进上下文,再让模型编写集成。这样可以避免模型依赖旧知识或猜测字段。
准备上下文
| 站内资源 | 用途 | 推荐方式 |
|---|---|---|
/webagent/llms.txt | 每页标题与一句描述的索引 | 让模型先定位相关页面 |
/webagent/llms-full.txt | 合并后的完整 Markdown 文档 | 下载或作为长上下文附件提供给模型 |
/openapi/v1.json | OpenAPI 3.1 schema | 下载并作为接口字段、请求与响应结构的依据 |
这些资源使用当前文档站的站内路径,不依赖独立文档域名。复制下面的规则前,先打开或下载所需资源,并将内容添加到 IDE 会话或项目上下文中。
拿来即用 prompt
复制到你的 IDE 系统 prompt / 规则文件 / 第一条消息:
你正在集成 WebAgent。只以我提供的 WebAgent 完整文档和 OpenAPI 3.1 schema 为准;如果上下文缺少所需接口或字段,先说明缺口,不要猜测。
API 约定:
- Base URL:https://api.eak.eazo.ai
- Bearer 鉴权:header `Authorization: Bearer wa_…`
- path 隔离 project:/v1/projects/{project_id}/...
- wire 字段一律 snake_case;decimal 用 JSON 字符串("10.00" 不是 10.00)
- 大多数变更端点支持 Idempotency-Key
SDK 包:
- Python: `pip install web-agent-sdk`
- TypeScript: `npm install web-agent-sdk`
两边 SDK 都自带 Last-Event-ID SSE 重连。优先用 SDK,除非用户要求纯 HTTP。
写代码前先读取附加的 OpenAPI schema,并根据完整文档确认调用流程。Cursor
.cursor/rules/webagent.md:
markdown
---
description: WebAgent 集成约定
globs: ["**/*.{ts,tsx,py}"]
---
写 WebAgent 代码前先读取项目提供的完整文档和 OpenAPI schema
字段名、请求和响应结构以 OpenAPI schema 为准——不允许猜
如果上下文没有定义所需接口,先询问再继续
默认用官方 SDK(`web-agent-sdk`),用户特别要求才用 raw HTTPClaude Code
加到项目 CLAUDE.md:
markdown
## WebAgent 集成
先读取项目附加的 WebAgent 完整文档和 OpenAPI schema。
SDK:`web-agent-sdk`(Python 与 TypeScript)
字段名、请求和响应结构以 OpenAPI schema 为准。wire 字段全 snake_case。订阅 run 事件用 SDK 的 `.stream()`,自带 `Last-Event-ID` 重连。如果上下文没有定义所需接口,先询问,不要猜测。更新上下文
当 WebAgent API 或 SDK 版本变化时,重新从本页的站内资源下载完整文档和 OpenAPI schema。不要在 IDE 规则文件中长期保存已经失效的外部文档域名。
Console "Get Code" 对话框
最快拿到能跑的代码:打开 Console,填表,点 Get Code。四个 tab(给 LLM agent 的 Prompt / Python / TypeScript / cURL),全部带你的真实 key 和当前配置。粘贴进编辑器即可。
为什么这套有效
- 文档和 schema 跟随当前项目或会话,不依赖固定的外部文档域名
llms-full.txt是 Markdown 而不是 HTML,LLM 可以直接解析- OpenAPI spec 是 SDK / Console 共同的单一真相,没有漂移
接下来
- Quickstart —— 5 分钟跑通第一个 run
- API 参考 —— 交互式 + Try-it