@agentseo/acp-adapter
v0.1.2
Published
The official Agent Communication Protocol (ACP) adapter for AgentSEO. Allows OpenClaw agents to import AgentSEO tools directly.
Readme
@agentseo/acp-adapter
The official Agent Communication Protocol (ACP) adapter for AgentSEO. Allows OpenClaw agents to import AgentSEO tools directly.
Quickstart
npm install @agentseo/acp-adapterSet your API key:
export AGENTSEO_API_KEY="sk_live_your_key"
export AGENTSEO_PROJECT_ID="client-alpha"
export AGENTSEO_WORKFLOW_ID="nightly-refresh"OpenClaw Usage
Import AgentSeoTools and attach them to your agent:
import { AgentSeoTools } from "@agentseo/acp-adapter";
// Example OpenClaw Agent
const agent = new OpenClaw.Agent({
name: "SEO Researcher",
tools: [...AgentSeoTools],
env: {
AGENTSEO_API_KEY: process.env.AGENTSEO_API_KEY,
AGENTSEO_PROJECT_ID: process.env.AGENTSEO_PROJECT_ID,
AGENTSEO_WORKFLOW_ID: process.env.AGENTSEO_WORKFLOW_ID,
},
});Minimal Smoke Test (No Agent Runtime Needed)
Create smoke-test.mjs:
import { AgentSeoTools } from "@agentseo/acp-adapter";
const searchTool = AgentSeoTools.find(
(tool) => tool.name === "agentseo_search",
);
if (!searchTool) {
throw new Error("agentseo_search tool not found");
}
const result = await searchTool.execute({
query: "agentic seo",
limit: 3,
});
console.log(result);Run:
node smoke-test.mjsAvailable Tools
Exports the following tools as ACP-compatible objects (with JSON Schema parameters):
agentseo_searchagentseo_extractagentseo_analyze_serpagentseo_local_auditagentseo_content_gapagentseo_ai_overview_extractagentseo_local_visibility_trackagentseo_rank_trackagentseo_job_status
Most workflow tools support a sync boolean for a short inline wait. If the API still returns a queued job payload, call agentseo_job_status with the returned jobId.
Requirements
- Node.js v18+
AGENTSEO_API_KEYenvironment variable must be set in your runtime.- Optional
AGENTSEO_API_URL(defaults tohttp://localhost:3000/api/v1). - Optional
AGENTSEO_PROJECT_IDandAGENTSEO_WORKFLOW_IDfor automatic attribution.
