fengming 0.3.10 → 0.3.12

package/docs/concepts/session-tool.md

@@ -1,188 +0,0 @@
----
-summary: "Agent tools for cross-session status, recall, messaging, and sub-agent orchestration"
-read_when:
-  - You want to understand what session tools the agent has
-  - You want to configure cross-session access or sub-agent spawning
-  - You want to inspect spawned sub-agent status
-title: "Session tools"
----
-
-FengMing gives agents tools to work across sessions, inspect status, and
-orchestrate sub-agents.
-
-## Available tools
-
-| Tool               | What it does                                                                |
-| ------------------ | --------------------------------------------------------------------------- |
-| `sessions_list`    | List sessions with optional filters (kind, label, agent, recency, preview)  |
-| `sessions_history` | Read the transcript of a specific session                                   |
-| `sessions_send`    | Send a message to another session and optionally wait                       |
-| `sessions_spawn`   | Spawn an isolated sub-agent session for background work                     |
-| `sessions_yield`   | End the current turn and wait for follow-up sub-agent results               |
-| `subagents`        | List spawned sub-agent status for this session                              |
-| `session_status`   | Show a `/status`-style card and optionally set a per-session model override |
-
-These tools are still subject to the active tool profile and allow/deny
-policy. `tools.profile: "coding"` includes the full session orchestration
-set, including `sessions_spawn`, `sessions_yield`, and `subagents`.
-`tools.profile: "messaging"` includes cross-session messaging tools
-(`sessions_list`, `sessions_history`, `sessions_send`, `session_status`) but
-does not include sub-agent spawning. To keep a messaging profile and still
-allow native delegation, add:
-
-```json5
-{
-  tools: {
-    profile: "messaging",
-    alsoAllow: ["sessions_spawn", "sessions_yield", "subagents"],
-  },
-}
-```
-
-Group, provider, sandbox, and per-agent policies can still remove those tools
-after the profile stage. Use `/tools` from the affected session to inspect the
-effective tool list.
-
-## Listing and reading sessions
-
-`sessions_list` returns sessions with their key, agentId, kind, channel, model,
-token counts, and timestamps. Filter by kind (`main`, `group`, `cron`, `hook`,
-`node`), exact `label`, exact `agentId`, search text, or recency
-(`activeMinutes`). When you need mailbox-style triage, it can also ask for a
-visibility-scoped derived title, a last-message preview snippet, or bounded recent
-messages on each row. Derived titles and previews are produced only for sessions
-the caller can already see under the configured session tool visibility policy, so
-unrelated sessions stay hidden. When visibility is restricted, `sessions_list`
-returns optional `visibility` metadata showing the effective mode and a warning that
-results may be scope-limited.
-
-`sessions_history` fetches the conversation transcript for a specific session.
-By default, tool results are excluded -- pass `includeTools: true` to see them.
-The returned view is intentionally bounded and safety-filtered:
-
-- assistant text is normalized before recall:
-  - thinking tags are stripped
-  - `<relevant-memories>` / `<relevant_memories>` scaffolding blocks are stripped
-  - plain-text tool-call XML payload blocks such as `<tool_call>...</tool_call>`,
-    `<function_call>...</function_call>`, `<tool_calls>...</tool_calls>`, and
-    `<function_calls>...</function_calls>` are stripped, including truncated
-    payloads that never close cleanly
-  - downgraded tool-call/result scaffolding such as `[Tool Call: ...]`,
-    `[Tool Result ...]`, and `[Historical context ...]` is stripped
-  - leaked model control tokens such as `<|assistant|>`, other ASCII
-    `<|...|>` tokens, and full-width `<｜...｜>` variants are stripped
-  - malformed MiniMax tool-call XML such as `<invoke ...>` /
-    `</minimax:tool_call>` is stripped
-- credential/token-like text is redacted before it is returned
-- long text blocks are truncated
-- very large histories can drop older rows or replace an oversized row with
-  `[sessions_history omitted: message too large]`
-- the tool reports summary flags such as `truncated`, `droppedMessages`,
-  `contentTruncated`, `contentRedacted`, and `bytes`
-
-Both tools accept either a **session key** (like `"main"`) or a **session ID**
-from a previous list call.
-
-If you need the exact byte-for-byte transcript, inspect the transcript file on
-disk instead of treating `sessions_history` as a raw dump.
-
-## Sending cross-session messages
-
-`sessions_send` delivers a message to another session and optionally waits for
-the response:
-
-- **Fire-and-forget:** set `timeoutSeconds: 0` to enqueue and return
-  immediately.
-- **Wait for reply:** set a timeout and get the response inline.
-
-Thread-scoped chat sessions, such as Slack or Discord keys ending in
-`:thread:<id>`, are not valid `sessions_send` targets. Use the parent channel
-session key for inter-agent coordination so tool-routed messages do not appear
-inside an active human-facing thread.
-
-Messages and A2A follow-up replies are marked as inter-session data in the
-receiving prompt (`[Inter-session message ... isUser=false]`) and in transcript
-provenance. The receiving agent should treat them as tool-routed data, not as a
-direct end-user-authored instruction.
-
-After the target responds, FengMing can run a **reply-back loop** where the
-agents alternate messages (up to `session.agentToAgent.maxPingPongTurns`, range
-0-20, default 5). The target agent can reply
-`REPLY_SKIP` to stop early.
-
-## Status and orchestration helpers
-
-`session_status` is the lightweight `/status`-equivalent tool for the current
-or another visible session. It reports usage, time, model/runtime state, and
-linked background-task context when present. Like `/status`, it can backfill
-sparse token/cache counters from the latest transcript usage entry, and
-`model=default` clears a per-session override. Use `sessionKey="current"` for
-the caller's current session; visible client labels such as `fengming-tui` are
-not session keys.
-
-`sessions_yield` intentionally ends the current turn so the next message can be
-the follow-up event you are waiting for. Use it after spawning sub-agents when
-you want completion results to arrive as the next message instead of building
-poll loops.
-
-`subagents` is the visibility helper for already spawned FengMing
-sub-agents. It supports `action: "list"` to inspect active/recent runs.
-
-## Spawning sub-agents
-
-`sessions_spawn` creates an isolated session for a background task by default.
-It is always non-blocking -- it returns immediately with a `runId` and
-`childSessionKey`. Native sub-agent runs receive the delegated task in the
-child session's first visible `[Subagent Task]` message, while the system
-prompt carries only sub-agent runtime rules and routing context.
-
-Key options:
-
-- `runtime: "subagent"` (default) or `"acp"` for external harness agents.
-- `model` and `thinking` overrides for the child session.
-- `thread: true` to bind the spawn to a chat thread (Discord, Slack, etc.).
-- `sandbox: "require"` to enforce sandboxing on the child.
-- `context: "fork"` for native sub-agents when the child needs the current
-  requester transcript; omit it or use `context: "isolated"` for a clean child.
-  Thread-bound native sub-agents default to `context: "fork"` unless
-  `threadBindings.defaultSpawnContext` says otherwise.
-
-Default leaf sub-agents do not get session tools. When
-`maxSpawnDepth >= 2`, depth-1 orchestrator sub-agents additionally receive
-`sessions_spawn`, `subagents`, `sessions_list`, and `sessions_history` so they
-can manage their own children. Leaf runs still do not get recursive
-orchestration tools.
-
-After completion, an announce step posts the result to the requester's channel.
-Completion delivery preserves bound thread/topic routing when available, and if
-the completion origin only identifies a channel FengMing can still reuse the
-requester session's stored route (`lastChannel` / `lastTo`) for direct
-delivery.
-
-For ACP-specific behavior, see [ACP Agents](/tools/acp-agents).
-
-## Visibility
-
-Session tools are scoped to limit what the agent can see:
-
-| Level   | Scope                                    |
-| ------- | ---------------------------------------- |
-| `self`  | Only the current session                 |
-| `tree`  | Current session + spawned sub-agents     |
-| `agent` | All sessions for this agent              |
-| `all`   | All sessions (cross-agent if configured) |
-
-Default is `tree`. Sandboxed sessions are clamped to `tree` regardless of
-config.
-
-## Further reading
-
-- [Session Management](/concepts/session) -- routing, lifecycle, maintenance
-- [ACP Agents](/tools/acp-agents) -- external harness spawning
-- [Multi-agent](/concepts/multi-agent) -- multi-agent architecture
-- [Gateway Configuration](/gateway/configuration) -- session tool config knobs
-
-## Related
-
-- [Session management](/concepts/session)
-- [Session pruning](/concepts/session-pruning)

package/docs/concepts/session.md

@@ -1,164 +0,0 @@
----
-summary: "How FengMing manages conversation sessions"
-read_when:
-  - You want to understand session routing and isolation
-  - You want to configure DM scope for multi-user setups
-  - You are debugging daily or idle session resets
-title: "Session management"
----
-
-FengMing organizes conversations into **sessions**. Each message is routed to a
-session based on where it came from -- DMs, group chats, cron jobs, etc.
-
-## How messages are routed
-
-| Source          | Behavior                  |
-| --------------- | ------------------------- |
-| Direct messages | Shared session by default |
-| Group chats     | Isolated per group        |
-| Rooms/channels  | Isolated per room         |
-| Cron jobs       | Fresh session per run     |
-| Webhooks        | Isolated per hook         |
-
-## DM isolation
-
-By default, all DMs share one session for continuity. This is fine for
-single-user setups.
-
-<Warning>
-If multiple people can message your agent, enable DM isolation. Without it, all
-users share the same conversation context -- Alice's private messages would be
-visible to Bob.
-</Warning>
-
-**The fix:**
-
-```json5
-{
-  session: {
-    dmScope: "per-channel-peer", // isolate by channel + sender
-  },
-}
-```
-
-Other options:
-
-- `main` (default) -- all DMs share one session.
-- `per-peer` -- isolate by sender (across channels).
-- `per-channel-peer` -- isolate by channel + sender (recommended).
-- `per-account-channel-peer` -- isolate by account + channel + sender.
-
-<Tip>
-If the same person contacts you from multiple channels, use
-`session.identityLinks` to link their identities so they share one session.
-</Tip>
-
-### Dock linked channels
-
-Dock commands let a user move the current direct-chat session's reply route to
-another linked channel without starting a new session. See
-[Channel docking](/concepts/channel-docking) for examples, config, and
-troubleshooting.
-
-Verify your setup with `fengming security audit`.
-
-## Session lifecycle
-
-Sessions are reused until they expire:
-
-- **Daily reset** (default) -- new session at 4:00 AM local time on the gateway
-  host. Daily freshness is based on when the current `sessionId` started, not
-  on later metadata writes.
-- **Idle reset** (optional) -- new session after a period of inactivity. Set
-  `session.reset.idleMinutes`. Idle freshness is based on the last real
-  user/channel interaction, so heartbeat, cron, and exec system events do not
-  keep the session alive.
-- **Manual reset** -- type `/new` or `/reset` in chat. `/new <model>` also
-  switches the model.
-
-When both daily and idle resets are configured, whichever expires first wins.
-Heartbeat, cron, exec, and other system-event turns may write session metadata,
-but those writes do not extend daily or idle reset freshness. When a reset
-rolls the session, queued system-event notices for the old session are
-discarded so stale background updates are not prepended to the first prompt in
-the new session.
-
-Sessions with an active provider-owned CLI session are not cut by the implicit
-daily default. Use `/reset` or configure `session.reset` explicitly when those
-sessions should expire on a timer.
-
-## Where state lives
-
-All session state is owned by the **gateway**. UI clients query the gateway for
-session data.
-
-- **Store:** `~/.fengming/agents/<agentId>/sessions/sessions.json`
-- **Transcripts:** `~/.fengming/agents/<agentId>/sessions/<sessionId>.jsonl`
-
-`sessions.json` keeps separate lifecycle timestamps:
-
-- `sessionStartedAt`: when the current `sessionId` began; daily reset uses this.
-- `lastInteractionAt`: last user/channel interaction that extends idle lifetime.
-- `updatedAt`: last store-row mutation; useful for listing and pruning, but not
-  authoritative for daily/idle reset freshness.
-
-Older rows without `sessionStartedAt` are resolved from the transcript JSONL
-session header when available. If an older row also lacks `lastInteractionAt`,
-idle freshness falls back to that session start time, not to later bookkeeping
-writes.
-
-## Session maintenance
-
-FengMing automatically bounds session storage over time. By default, it runs
-in `warn` mode (reports what would be cleaned). Set `session.maintenance.mode`
-to `"enforce"` for automatic cleanup:
-
-```json5
-{
-  session: {
-    maintenance: {
-      mode: "enforce",
-      pruneAfter: "30d",
-      maxEntries: 500,
-    },
-  },
-}
-```
-
-For production-sized `maxEntries` limits, Gateway runtime writes use a small high-water buffer and clean back down to the configured cap in batches. Session store reads do not prune or cap entries during Gateway startup. This avoids running full store cleanup on every startup or isolated cron session. `fengming sessions cleanup --enforce` applies the cap immediately.
-
-Maintenance preserves durable external conversation pointers, including group
-sessions and thread-scoped chat sessions, while still allowing synthetic cron,
-hook, heartbeat, ACP, and sub-agent entries to age out.
-
-If you previously used direct-message isolation and later returned
-`session.dmScope` to `main`, preview stale peer-keyed DM rows with
-`fengming sessions cleanup --dry-run --fix-dm-scope`. Applying the same flag
-retires those old direct-DM rows and keeps their transcripts as deleted
-archives.
-
-Preview with `fengming sessions cleanup --dry-run`.
-
-## Inspecting sessions
-
-- `fengming status` -- session store path and recent activity.
-- `fengming sessions --json` -- all sessions (filter with `--active <minutes>`).
-- `/status` in chat -- context usage, model, and toggles.
-- `/context list` -- what is in the system prompt.
-
-## Further reading
-
-- [Session Pruning](/concepts/session-pruning) -- trimming tool results
-- [Compaction](/concepts/compaction) -- summarizing long conversations
-- [Session Tools](/concepts/session-tool) -- agent tools for cross-session work
-- [Session Management Deep Dive](/reference/session-management-compaction) --
-  store schema, transcripts, send policy, origin metadata, and advanced config
-- [Multi-Agent](/concepts/multi-agent) — routing and session isolation across agents
-- [Background Tasks](/automation/tasks) — how detached work creates task records with session references
-- [Channel Routing](/channels/channel-routing) — how inbound messages are routed to sessions
-
-## Related
-
-- [Session pruning](/concepts/session-pruning)
-- [Session tools](/concepts/session-tool)
-- [Command queue](/concepts/queue)

package/docs/concepts/soul.md

@@ -1,116 +0,0 @@
----
-summary: "Use SOUL.md to give your FengMing agent an actual voice instead of generic assistant sludge"
-read_when:
-  - You want your agent to sound less generic
-  - You are editing SOUL.md
-  - You want a stronger personality without breaking safety or brevity
-title: "SOUL.md personality guide"
----
-
-`SOUL.md` is where your agent's voice lives.
-
-FengMing injects it on normal sessions, so it has real weight. If your agent
-sounds bland, hedgy, or weirdly corporate, this is usually the file to fix.
-
-## What belongs in SOUL.md
-
-Put the stuff that changes how the agent feels to talk to:
-
-- tone
-- opinions
-- brevity
-- humor
-- boundaries
-- default level of bluntness
-
-Do **not** turn it into:
-
-- a life story
-- a changelog
-- a security policy dump
-- a giant wall of vibes with no behavioral effect
-
-Short beats long. Sharp beats vague.
-
-## Why this works
-
-This lines up with OpenAI's prompt guidance:
-
-- The prompt engineering guide says high-level behavior, tone, goals, and
-  examples belong in the high-priority instruction layer, not buried in the
-  user turn.
-- The same guide recommends treating prompts like something you iterate on,
-  pin, and evaluate, not magical prose you write once and forget.
-
-For FengMing, `SOUL.md` is that layer.
-
-If you want better personality, write stronger instructions. If you want stable
-personality, keep them concise and versioned.
-
-OpenAI refs:
-
-- [Prompt engineering](https://developers.openai.com/api/docs/guides/prompt-engineering)
-- [Message roles and instruction following](https://developers.openai.com/api/docs/guides/prompt-engineering#message-roles-and-instruction-following)
-
-## The Molty prompt
-
-Paste this into your agent and let it rewrite `SOUL.md`.
-
-Path fixed for FengMing workspaces: use `SOUL.md`, not `http://SOUL.md`.
-
-```md
-Read your `SOUL.md`. Now rewrite it with these changes:
-
-1. You have opinions now. Strong ones. Stop hedging everything with "it depends" - commit to a take.
-2. Delete every rule that sounds corporate. If it could appear in an employee handbook, it doesn't belong here.
-3. Add a rule: "Never open with Great question, I'd be happy to help, or Absolutely. Just answer."
-4. Brevity is mandatory. If the answer fits in one sentence, one sentence is what I get.
-5. Humor is allowed. Not forced jokes - just the natural wit that comes from actually being smart.
-6. You can call things out. If I'm about to do something dumb, say so. Charm over cruelty, but don't sugarcoat.
-7. Swearing is allowed when it lands. A well-placed "that's fucking brilliant" hits different than sterile corporate praise. Don't force it. Don't overdo it. But if a situation calls for a "holy shit" - say holy shit.
-8. Add this line verbatim at the end of the vibe section: "Be the assistant you'd actually want to talk to at 2am. Not a corporate drone. Not a sycophant. Just... good."
-
-Save the new `SOUL.md`. Welcome to having a personality.
-```
-
-## What good looks like
-
-Good `SOUL.md` rules sound like this:
-
-- have a take
-- skip filler
-- be funny when it fits
-- call out bad ideas early
-- stay concise unless depth is actually useful
-
-Bad `SOUL.md` rules sound like this:
-
-- maintain professionalism at all times
-- provide comprehensive and thoughtful assistance
-- ensure a positive and supportive experience
-
-That second list is how you get mush.
-
-## One warning
-
-Personality is not permission to be sloppy.
-
-Keep `AGENTS.md` for operating rules. Keep `SOUL.md` for voice, stance, and
-style. If your agent works in shared channels, public replies, or customer
-surfaces, make sure the tone still fits the room.
-
-Sharp is good. Annoying is not.
-
-## Related
-
-<CardGroup cols={2}>
-  <Card title="Agent workspace" href="/concepts/agent-workspace" icon="folder-open">
-    Workspace files FengMing injects into model context.
-  </Card>
-  <Card title="System prompt" href="/concepts/system-prompt" icon="message-lines">
-    How `SOUL.md` is composed into FengMing and Codex runtime context.
-  </Card>
-  <Card title="SOUL.md template" href="/reference/templates/SOUL" icon="file-lines">
-    Starter template for a personality file.
-  </Card>
-</CardGroup>