Document the built-in Harper Agent (`agent:` config, `agent_prompt` ops, `harper agent` CLI)
メンテナーはふだん 1 日以内に返信
@DavidCockerill がすでに取り組んでいます。
2026年9月18日 から。
評価
この issue はまだ評価されていません。
説明
Problem
Harper 5.1+ ships an in-process agent component (Built-in Harper Agent Component, landed in feat(agent): scaffold built-in Harper Agent component, first release tag v5.1.0). Nothing on docs.harper.fast describes it. The two pages that mention agents cover different things:
- Using AI Agents documents
harper-agent, the external CLI from HarperFast/agent that runs on the developer's machine. - AI & Models overview and Tool calling document the
Models.generate({ toolMode: 'auto' })library loop.
Zero hits in the repo (all branches) for agent_prompt, hdb_agent, agent.enabled, or harper agent.
What to document
A new reference page under AI & Models (reference/models/agent.md or similar), plus a short pointer from the getting-started agents page distinguishing the two agents.
Source of truth, all in HarperFast/harper main:
- Config — the
agentblock inconfig-root.schema.json(~L694):enabled(defaultfalse, off to avoid surprise LLM cost),provider,model,maxTurns(default 50),maxCostUsd,autoApprove,allowDestructive,user(defaulthdb_agent, created at startup),componentsScope,systemPromptAppend. Requires amodels.generativeentry for the model it uses. - Operations API —
agent/operations.ts:agent_prompt,get_agent_session,list_agent_sessions,approve_agent_action,set_agent_config. Grantable to a non-super_user role viaoperations: ['agent']. - CLI —
bin/agentCli.ts:harper agent [message](aliasharper chat), one-shot and REPL modes,--target/--session/--json/--once, local UDS or remote ops API, approval prompts onawaiting_approval. - Toolset and safety posture —
agent/toolset.ts,agent/tools/: read-only by default (read/list/grep/tail files,http_fetch, inspector attach + CPU profile, best-practices lookup,schedule_followup);allowDestructive: trueaddswrite_filescoped to components; operations-profile tools follow themcp.operations.allowlist and the agent user's permissions. Document what it can and cannot do out of the box so nobody expects self-deploy. - Lifecycle — component edits need a restart to take effect (no hot class reload); session continuation.
Suggested outline: What it is (vs. harper-agent CLI, vs. toolMode: 'auto') → Enable (config, generative model, cost guard) → Talk to it (CLI, ops API) → Tools and permissions → Approval flow → Limits.
Out of scope
- Fabric provisioning does not enable the agent on instances; that is central-manager#457. The page should state the agent is off by default and link nowhere Fabric-specific until that lands.
models.*cannot be set viaset_configuration(harper#2267). Mention as a known limit, do not work around it in the docs.
Acceptance
- Reference page live under AI & Models, listed in
sidebarsReference.ts. - Every config key, operation, and CLI flag above is covered and verified against
harpermain at time of writing (note the SHA in the source comment, astool-calling.mddoes). - Getting-started agents page gains a two-sentence pointer: external
harper-agentCLI vs. in-process built-in agent. - Searching the site for
agent_promptorharper agentfinds the page.
- 主要言語
- MDX
- スター
- 9
- フォーク
- 9
- 平均マージ
- 2日 3時間
- マージ済み PR(30日)
- 30
環境構築
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
HarperFast/documentation のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
HarperFast/documentation#677 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 半日 初心者へのやさしさ 88/100
HarperFast/documentation#675 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
HarperFast/documentation#665 ·
メンテナーはふだん 1 日以内に返信
-
content
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
HarperFast/documentation#478 ·
メンテナーはふだん 1 日以内に返信
-
content
難易度 1/5 1時間未満 初心者へのやさしさ 76/100
HarperFast/documentation#399 · コメント 2 件 ·
メンテナーはふだん 1 日以内に返信