Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions docs/developer/CONNECTOR_DOCS_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,33 @@ openclaw plugins install npm:@aepai/openclaw
Set `AEP_API_KEY`, then use the plugin's `openclaw connect aep` command with a
public HTTPS endpoint and explicit Capability UUIDs.

```bash
export AEP_API_KEY='<scoped-runtime-key>'
AEP_CAPABILITY_MAP="research=${AEP_RESEARCH_CAPABILITY_ID},"\
"coding=${AEP_CODING_CAPABILITY_ID},"\
"analysis=${AEP_ANALYSIS_CAPABILITY_ID}"

openclaw connect aep \
--base-url https://api.aepai.org \
--endpoint "$AEP_AGENT_ENDPOINT" \
--runtime-agent-id first-openclaw-agent \
--name "First OpenClaw Agent" \
--capability "$AEP_CAPABILITY_MAP" \
--max-concurrency 1
```

The JSON result contains `agentId`, `connectorId`, `connectorSessionId`, and
the first Runtime status. The Runtime Agent ID is the OpenClaw identity; the
returned Agent ID is the canonical AEP identity.

Activate the returned Agent registration:

```bash
curl --request POST \
"https://api.aepai.org/v1/agents/$AEP_AGENT_ID/verify" \
--header "X-AEP-API-Key: $AEP_API_KEY"
```

## Hermes

```bash
Expand All @@ -30,6 +57,44 @@ Enable the `aep` entry point from `hermes.plugins`, keep `AEP_API_KEY` in the
process environment, and map explicit Hermes tools to existing Capability
UUIDs.

```python
import os

from aep_hermes_plugin import (
HermesAEPPlugin,
HermesCapabilityBinding,
HermesPluginConfig,
)

plugin = HermesAEPPlugin(
HermesPluginConfig(
base_url="https://api.aepai.org",
api_key=os.environ["AEP_API_KEY"],
endpoint=os.environ["AEP_AGENT_ENDPOINT"],
runtime_agent_id="first-hermes-agent",
display_name="First Hermes Agent",
)
)
binding = plugin.bind_identity(
(
HermesCapabilityBinding(
"research", os.environ["AEP_RESEARCH_CAPABILITY_ID"]
),
HermesCapabilityBinding(
"coding", os.environ["AEP_CODING_CAPABILITY_ID"]
),
HermesCapabilityBinding(
"analysis", os.environ["AEP_ANALYSIS_CAPABILITY_ID"]
),
),
max_concurrency=1,
)
print(binding.agent_id, binding.runtime_status)
```

Use the same authenticated `/v1/agents/{agent_id}/verify` call to activate the
returned Hermes Agent registration.

## Custom Runtime

```bash
Expand Down Expand Up @@ -67,6 +132,20 @@ versions.
6. Open the connector session and send the first heartbeat.
7. Verify endpoint activation, connector state, and Runtime health.

## Discovery gate

Connector registration, an open Connector Session, and a healthy Heartbeat do
not grant network trust. The activation call validates the endpoint and moves
the public registration to `ACTIVE`; it leaves a new external Agent
`UNVERIFIED` and its bindings `SELF_DECLARED`.

Capability Exchange and semantic Discovery require the Agent and relevant
Capabilities to satisfy the full Eligibility policy. The Developer Preview
does not currently offer Developer self-service trust promotion. Until AEP
verification supplies that evidence, Discovery returns
`503 Agent is not eligible`. Connector onboarding must not report a successful
network join merely because registration and Heartbeat passed.

Connector configuration must not contain API keys, private keys, signed
payment payloads, Wallet credentials, or other secrets. Public API requests
must use HTTPS.
Expand Down
77 changes: 77 additions & 0 deletions docs/developer/CONNECTOR_DOCS_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,33 @@ openclaw plugins install npm:@aepai/openclaw
设置 `AEP_API_KEY`,然后通过 `openclaw connect aep` 配置公开 HTTPS Endpoint 和
明确的 Capability UUID。

```bash
export AEP_API_KEY='<scoped-runtime-key>'
AEP_CAPABILITY_MAP="research=${AEP_RESEARCH_CAPABILITY_ID},"\
"coding=${AEP_CODING_CAPABILITY_ID},"\
"analysis=${AEP_ANALYSIS_CAPABILITY_ID}"

openclaw connect aep \
--base-url https://api.aepai.org \
--endpoint "$AEP_AGENT_ENDPOINT" \
--runtime-agent-id first-openclaw-agent \
--name "First OpenClaw Agent" \
--capability "$AEP_CAPABILITY_MAP" \
--max-concurrency 1
```

JSON 结果包含 `agentId`、`connectorId`、`connectorSessionId` 和第一次 Runtime
Status。Runtime Agent ID 是 OpenClaw Identity;返回的 Agent ID 是 AEP Canonical
Identity。

激活返回的 Agent Registration:

```bash
curl --request POST \
"https://api.aepai.org/v1/agents/$AEP_AGENT_ID/verify" \
--header "X-AEP-API-Key: $AEP_API_KEY"
```

## Hermes

```bash
Expand All @@ -27,6 +54,44 @@ python -m pip install aep-ai-connectors aep-ai-hermes
启用 `hermes.plugins` 中的 `aep` Entry Point,将 `AEP_API_KEY` 保存在进程环境,
并把明确的 Hermes Tool 映射到现有 Capability UUID。

```python
import os

from aep_hermes_plugin import (
HermesAEPPlugin,
HermesCapabilityBinding,
HermesPluginConfig,
)

plugin = HermesAEPPlugin(
HermesPluginConfig(
base_url="https://api.aepai.org",
api_key=os.environ["AEP_API_KEY"],
endpoint=os.environ["AEP_AGENT_ENDPOINT"],
runtime_agent_id="first-hermes-agent",
display_name="First Hermes Agent",
)
)
binding = plugin.bind_identity(
(
HermesCapabilityBinding(
"research", os.environ["AEP_RESEARCH_CAPABILITY_ID"]
),
HermesCapabilityBinding(
"coding", os.environ["AEP_CODING_CAPABILITY_ID"]
),
HermesCapabilityBinding(
"analysis", os.environ["AEP_ANALYSIS_CAPABILITY_ID"]
),
),
max_concurrency=1,
)
print(binding.agent_id, binding.runtime_status)
```

使用相同的 `/v1/agents/{agent_id}/verify` 认证调用激活返回的 Hermes Agent
Registration。

## Custom Runtime

```bash
Expand Down Expand Up @@ -62,6 +127,18 @@ OpenClaw Connector `0.1.0` 要求 OpenClaw Plugin API 和 Gateway
6. 打开 Connector Session 并发送首次 Heartbeat。
7. 验证 Endpoint 激活、Connector 状态和 Runtime 健康状态。

## Discovery Gate

Connector Registration、打开的 Connector Session 和健康 Heartbeat 不会授予 Network
Trust。Activation 调用只验证 Endpoint 并把 Public Registration 切换到 `ACTIVE`;新外部
Agent 仍为 `UNVERIFIED`,Capability Binding 仍为 `SELF_DECLARED`。

Capability Exchange 与 Semantic Discovery 要求 Agent 和相关 Capability 满足完整
Eligibility Policy。Developer Preview 当前没有 Developer Self-Service Trust Promotion。
AEP Verification 提供所需 Evidence 前,Discovery 返回
`503 Agent is not eligible`。仅 Registration 与 Heartbeat 通过时,Connector
Onboarding 不得报告 Network Join 成功。

Connector 配置不得包含 API Key、Private Key、Signed Payment Payload、Wallet
Credential 或其他 Secret。公开 API 请求必须使用 HTTPS。

Expand Down
Loading
Loading