---
document_id: agent.getting_started
schema_version: 1
---

<!-- Generated by scripts.build_agent_guide; do not edit. -->

# Getting started / 开始接入

Connect Asklear to your Agent with Streamable HTTP MCP and verify the first authenticated tool call.

通过 Streamable HTTP MCP 将 Asklear 接入你的 Agent，并验证第一次认证工具调用。

## Before you connect / 接入前

- The Dashboard message contains the exact MCP URL and an active access key. Use both to configure asklear; the URL ends in /mcp and uses HTTPS outside local development. Keep the key confined to MCP configuration.
  Dashboard 消息包含准确的 MCP URL 和有效访问密钥，直接用它们配置 asklear；地址以 /mcp 结尾，非本地环境使用 HTTPS。Key 仅用于 MCP 配置。
- Before creating anything, inspect the current client for a server named asklear. If its URL matches, reuse it with the credential supplied in the onboarding message and do not duplicate the server. If the URL differs, stop and ask the user before changing it.
  创建任何配置前，先检查当前客户端是否已有名为 asklear 的服务。URL 相同时直接复用并使用接入消息提供的凭据，不得重复创建服务；URL 不同时停止并让用户确认后再修改。
- Public examples use URL and key placeholders only because they are shared documentation. Replace those placeholders with the URL and key already present in the current onboarding message. If the client requires a native trust, publish, restart, or confirmation action that the Agent cannot perform, state that remaining action precisely.
  公共示例使用 URL 和 Key 占位符只是因为它们属于共享文档。用当前接入消息中已有的 URL 和 Key 替换占位符。如果客户端要求 Agent 无法代办的原生信任、发布、重启或确认动作，准确说明剩余动作。
- MCP initialization instructions are sufficient for normal use. Consult /docs/agent/index.md only when the client does not surface them or a capability error requires recovery.
  正常使用只需遵循 MCP 初始化说明；仅当客户端没有展示这些说明或能力错误需要恢复时，才查看 /docs/agent/index.md。

## Required components / 必装组件

- Asklear MCP (required): install one remote Streamable HTTP server named asklear through the current client's documented MCP or connector entry point.
  Asklear MCP（必装）：通过当前客户端有文档支持的 MCP 或连接器入口，安装一个名为 asklear 的远程 Streamable HTTP 服务。

## Completion criteria / 完成标准

- Confirm the asklear server is enabled by listing its MCP tools.
  通过列出 MCP 工具确认 asklear 服务已经启用。
- Complete one authenticated MCP operation. Prefer the user's first real search or query and report its data-through; with no question yet, call connection_status and report the connection status.
  完成一次经过认证的 MCP 操作。优先执行用户的首个真实搜索或查询并报告数据截止时间；尚无问题时调用 connection_status 并报告连接状态。

## Choose this client / 选择当前客户端

- [Codex](/docs/agent/clients/codex.md)
- [Claude Code](/docs/agent/clients/claude_code.md)
- [Manus](/docs/agent/clients/manus.md)
- [OpenClaw](/docs/agent/clients/openclaw.md)
- [Hermes](/docs/agent/clients/hermes.md)
- [WorkBuddy](/docs/agent/clients/workbuddy.md)
- [QoderWork](/docs/agent/clients/qoderwork.md)
- [Trae Work](/docs/agent/clients/trae.md)