M0: compilable skeleton — Kigi 0.1.0 fork surgery
Hard fork of xai-org/grok-build (Apache-2.0) re-targeted as Kigi, an
unofficial Kimi Code CLI community build.
Rename & identity
- 72 xai-*/xai-grok-* crates -> kigi-* (explicit: xai-grok-pager-bin ->
kigi-bin [binary `kigi`], xai-grok-pager -> kigi-tui; rest mechanical);
ptyctl, ptyctl-cli, third_party/ unchanged; proto package
xai.grok.tools.v1 -> kigi.tools.v1
- Config home ~/.kigi (KIGI_SHARE_DIR override), env prefix GROK_* ->
KIGI_*, `kigi --version` carries the unofficial-community-build notice
- clap identity, help text, startup banner, prompt templates rebranded
(templates re-encrypted)
Deletions (PRD removal list #5/#6/#7/#9/#10)
- voice input (xai-grok-voice) and all TUI wiring
- telemetry: Mixpanel client, external OTel stream, Sentry, OTLP layers,
trace/GCS/S3 upload queues (kigi-file-utils halved), workspace upload
module & dc_log, heap-profile uploader, auth-diagnostics uploader,
session-analytics halves of feedback; local zero-egress observability
preserved in new kigi-log crate (unified log, --debug firehose,
subsystem file logs, opt-in instrumentation)
- announcements (crate, remote-settings fields, TUI surfaces)
- plugin marketplace (crate, sources/browse/CTA/extensions-modal tab);
direct plugin install/uninstall/update via kigi-agent git_install kept
- relay/gateway/assets endpoints and features (agent relay, headless
relay transport, gateway bridge, LeaderEnvUrls); leader IPC socket now
~/.kigi/leader.sock + KIGI_LEADER_SOCKET, no ws-url derivation
- functional types rehomed instead of deleted: PermissionMode ->
kigi-config-types, McpInitStrategy -> kigi-mcp, PrCreationSource ->
session signals, TerminalDiagnostics -> kigi-pager-render, agent_id ->
shell util
Endpoints
- kigi-env rewritten: single production KigiEndpoints {coding_api_base_url
https://api.kimi.com/coding/v1 (KIGI_CODE_BASE_URL), oauth_host
https://auth.kimi.com (KIGI_OAUTH_HOST), update_base_url (GitHub
Releases API), upgrade_page_url}; GrokBuildEnvironment enum deleted
Toolchain & workspace hygiene
- Rust 1.97.0 pinned; edition 2024; full cargo update; git2 hoisted to
workspace at 0.21 (Option->Result API migration), quick-xml 0.41
- Root Cargo.toml hand-maintained (PRD §8.1): version 0.1.0 inherited by
all members, members sorted, unused deps pruned
- cargo-deny advisories gate (deny.toml with documented transitive
exceptions); CI workflow (check/clippy/fmt/deny/test, macOS+Linux)
- cross-crate test seams re-gated behind `test-support` cargo feature;
insta snapshot baselines renamed to the kigi_tui prefix
- clippy --workspace --all-targets: zero warnings; fmt clean
Fixes surfaced by the port
- updater probe/installer divergence (bin/kigi vs bin/grok symlink set)
- idle model-metadata refresh dead under KIGI_CODE_BASE_URL override
(new is_effective_coding_endpoint_url, loopback+override aware)
- macOS symlinked-TMPDIR fixture canonicalization (foreign_sessions,
fast-worktree); RSS measurement tests serialized via serial_test
Docs & legal (Apache §4)
- NOTICE added (upstream attribution + change statement); THIRD-PARTY
notices sustained; kigi-tools ported-code notices extended; README,
CONTRIBUTING, SECURITY, AGENTS.md rewritten
Out of scope for M0 (tracked): Kimi auth/inference (M1), search/fetch,
command parity, config import (M2), Computer Hub excision & final
brand-token sweep (M2), distribution & self-update rewrite (M3).
This commit is contained in:
@@ -0,0 +1,296 @@
|
||||
//! Agent — a fully built agent: definition + session context.
|
||||
|
||||
use std::sync::Arc;
|
||||
|
||||
use kigi_sampling_types::HostedTool;
|
||||
use kigi_tools::bridge::ToolBridge;
|
||||
use kigi_tools::types::definition::ToolDefinition;
|
||||
|
||||
use crate::compaction::CompactionPolicy;
|
||||
use crate::config::{AgentDefinition, CompletionRequirement, PermissionMode};
|
||||
use crate::prompt::context::PromptContext;
|
||||
use crate::system_reminder::ReminderPolicy;
|
||||
|
||||
/// A fully built agent: definition + session context.
|
||||
///
|
||||
/// NOT portable — tied to a specific session via its ToolBridge,
|
||||
/// rendered system prompt, and session-level policies.
|
||||
///
|
||||
/// Created by AgentBuilder from an AgentDefinition + session context.
|
||||
///
|
||||
/// The Agent is effectively immutable after construction. It holds
|
||||
/// Arc<ToolBridge> — mutations to tool state (MCP registration,
|
||||
/// completion tracking, retry config) go through ToolBridge's
|
||||
/// internal locks.
|
||||
pub struct Agent {
|
||||
/// The definition this agent was built from.
|
||||
definition: AgentDefinition,
|
||||
|
||||
/// The context that produced the current system prompt.
|
||||
/// Stored for inspection, re-rendering, and serialization.
|
||||
prompt_context: PromptContext,
|
||||
|
||||
/// The rendered system prompt (cached from prompt_context.render()).
|
||||
system_prompt: String,
|
||||
|
||||
/// The tool bridge — owns ToolRegistry + ToolState + SessionContext.
|
||||
tool_bridge: Arc<ToolBridge>,
|
||||
|
||||
/// Session-level policies.
|
||||
reminder_policy: ReminderPolicy,
|
||||
compaction_policy: CompactionPolicy,
|
||||
|
||||
/// Backend-hosted tools to include in API requests.
|
||||
/// These are sent as native Responses API types (e.g., `WebSearch`)
|
||||
/// and executed server-side by the agentic sampler.
|
||||
hosted_tools: Vec<HostedTool>,
|
||||
|
||||
/// Build-time toggle for server-side search tools. ANDed at request
|
||||
/// time with the per-model `SessionActor::supports_backend_search`.
|
||||
backend_search_enabled: bool,
|
||||
}
|
||||
|
||||
impl Agent {
|
||||
/// Create a new Agent.
|
||||
///
|
||||
/// Normally called by `AgentBuilder::build()`. Exposed publicly for
|
||||
/// test helpers that need to construct an Agent with a pre-built ToolBridge.
|
||||
pub fn new(
|
||||
definition: AgentDefinition,
|
||||
prompt_context: PromptContext,
|
||||
system_prompt: String,
|
||||
tool_bridge: Arc<ToolBridge>,
|
||||
reminder_policy: ReminderPolicy,
|
||||
compaction_policy: CompactionPolicy,
|
||||
hosted_tools: Vec<HostedTool>,
|
||||
backend_search_enabled: bool,
|
||||
) -> Self {
|
||||
Self {
|
||||
definition,
|
||||
prompt_context,
|
||||
system_prompt,
|
||||
tool_bridge,
|
||||
reminder_policy,
|
||||
compaction_policy,
|
||||
hosted_tools,
|
||||
backend_search_enabled,
|
||||
}
|
||||
}
|
||||
|
||||
// ── From definition ──────────────────────────────────────────────
|
||||
|
||||
/// Agent name (unique identifier).
|
||||
pub fn name(&self) -> &str {
|
||||
&self.definition.name
|
||||
}
|
||||
|
||||
/// Agent description.
|
||||
pub fn description(&self) -> &str {
|
||||
&self.definition.description
|
||||
}
|
||||
|
||||
/// The full agent definition.
|
||||
pub fn definition(&self) -> &AgentDefinition {
|
||||
&self.definition
|
||||
}
|
||||
|
||||
/// Permission mode for this agent.
|
||||
pub fn permission_mode(&self) -> &PermissionMode {
|
||||
&self.definition.permission_mode
|
||||
}
|
||||
|
||||
/// Completion requirement, if any.
|
||||
pub fn completion_requirement(&self) -> Option<&CompletionRequirement> {
|
||||
self.definition.completion_requirement.as_ref()
|
||||
}
|
||||
|
||||
// ── Session-level ────────────────────────────────────────────────
|
||||
|
||||
/// The rendered system prompt.
|
||||
pub fn system_prompt(&self) -> &str {
|
||||
&self.system_prompt
|
||||
}
|
||||
|
||||
/// Compact system prompt for post-compaction use.
|
||||
///
|
||||
/// Returns a static string — the compact prompt never changes at runtime.
|
||||
pub fn compact_system_prompt(&self) -> &str {
|
||||
crate::prompt::template::COMPACT_SYSTEM_PROMPT
|
||||
}
|
||||
|
||||
/// The tool bridge for this agent.
|
||||
pub fn tool_bridge(&self) -> &Arc<ToolBridge> {
|
||||
&self.tool_bridge
|
||||
}
|
||||
|
||||
/// Compaction policy.
|
||||
pub fn compaction_policy(&self) -> &CompactionPolicy {
|
||||
&self.compaction_policy
|
||||
}
|
||||
|
||||
/// Reminder policy.
|
||||
pub fn reminder_policy(&self) -> &ReminderPolicy {
|
||||
&self.reminder_policy
|
||||
}
|
||||
|
||||
/// Cached AGENTS.md section (derived from prompt_context).
|
||||
pub fn agents_md_section(&self) -> Option<String> {
|
||||
self.prompt_context.format_agents_md_section()
|
||||
}
|
||||
|
||||
/// AGENTS.md content formatted for user-message injection.
|
||||
///
|
||||
/// Returns the `<system-reminder>` block to prepend as a user message,
|
||||
/// respecting audience (compacted for subagents) and template.
|
||||
pub fn agents_md_user_reminder(&self) -> Option<String> {
|
||||
self.prompt_context.agents_md_user_reminder()
|
||||
}
|
||||
|
||||
/// Personas content formatted for user-message injection.
|
||||
///
|
||||
/// Returns the `<system-reminder>` block to prepend as a user message,
|
||||
/// respecting audience (suppressed for subagents) and template.
|
||||
pub fn personas_user_reminder(&self) -> Option<String> {
|
||||
self.prompt_context.personas_user_reminder()
|
||||
}
|
||||
|
||||
/// The structured prompt context for inspection and re-rendering.
|
||||
pub fn prompt_context(&self) -> &PromptContext {
|
||||
&self.prompt_context
|
||||
}
|
||||
|
||||
/// Audience this agent's prompt was rendered for (Primary or Subagent).
|
||||
///
|
||||
/// Used by the runtime turn-end TodoGate together with
|
||||
/// [`crate::AgentDefinition::carries_task_completion_discipline`] to
|
||||
/// decide whether the active prompt actually carries the discipline
|
||||
/// rules the gate's reminder text invokes.
|
||||
pub fn prompt_audience(&self) -> crate::prompt::context::PromptAudience {
|
||||
self.prompt_context.audience
|
||||
}
|
||||
|
||||
/// Tool definitions for the sampling API — delegates to ToolBridge.
|
||||
pub async fn tool_definitions(&self) -> Vec<ToolDefinition> {
|
||||
self.tool_bridge.tool_definitions().await
|
||||
}
|
||||
|
||||
/// Backend-hosted tools that should be included in API requests.
|
||||
/// These are sent as native types (e.g., `rs::Tool::WebSearch`) and
|
||||
/// executed server-side by the agentic sampler.
|
||||
pub fn hosted_tools(&self) -> &[HostedTool] {
|
||||
&self.hosted_tools
|
||||
}
|
||||
|
||||
/// Build-time toggle for server-side search tools. Callers should
|
||||
/// AND this with the per-model `supports_backend_search` flag to
|
||||
/// decide whether to ship `hosted_tools` on a request. Do not use
|
||||
/// `hosted_tools().is_empty()` as a proxy — the list also depends
|
||||
/// on web-search config.
|
||||
pub fn backend_search_enabled(&self) -> bool {
|
||||
self.backend_search_enabled
|
||||
}
|
||||
|
||||
/// Built-in tool definitions only (excludes MCP tools).
|
||||
pub async fn tool_definitions_builtins_only(&self) -> Vec<ToolDefinition> {
|
||||
self.tool_bridge.tool_definitions_builtins_only().await
|
||||
}
|
||||
|
||||
/// Whether auto-compact should trigger given current token usage.
|
||||
///
|
||||
/// `context_window` comes from the session's SamplingConfig (model-provided).
|
||||
pub fn should_auto_compact(
|
||||
&self,
|
||||
total_tokens: u64,
|
||||
context_window: std::num::NonZeroU64,
|
||||
) -> bool {
|
||||
let cw = context_window.get();
|
||||
kigi_token_estimation::exceeds_threshold(
|
||||
total_tokens,
|
||||
cw,
|
||||
self.compaction_policy.auto_compact_threshold_percent as u8,
|
||||
)
|
||||
}
|
||||
|
||||
/// Update completion and retry policies from a new definition.
|
||||
///
|
||||
/// Does NOT rebuild the tool registry or re-render prompts.
|
||||
/// Used for mid-session mode switching.
|
||||
pub async fn update_policies_from_definition(&self, _def: &AgentDefinition) {
|
||||
// TODO: completion requirements and retry configs are now part of
|
||||
// ToolServerConfig and handled at registry finalization time.
|
||||
// Mid-session policy updates are not yet supported in the new architecture.
|
||||
}
|
||||
|
||||
/// Re-render the system prompt from current ToolBridge state
|
||||
/// (tool name overrides, disabled tools). Called by hosts after
|
||||
/// mid-session tool-override updates.
|
||||
pub async fn finalize_prompt(&mut self) {
|
||||
self.prompt_context.build_timestamp_utc = chrono::Utc::now().to_rfc3339();
|
||||
|
||||
self.system_prompt = self
|
||||
.prompt_context
|
||||
.render(&self.tool_bridge)
|
||||
.await
|
||||
.unwrap_or_default();
|
||||
}
|
||||
|
||||
/// Re-render the system prompt for a different definition, reusing
|
||||
/// the existing ToolBridge. Used for mid-session mode switching.
|
||||
pub async fn render_prompt_for_definition(&self, definition: &AgentDefinition) -> String {
|
||||
let mut ctx = self.prompt_context.clone();
|
||||
ctx.prompt_mode = definition.prompt_mode.clone();
|
||||
ctx.prompt_body = definition.prompt_body.clone();
|
||||
ctx.system_prompt = definition.system_prompt.clone();
|
||||
ctx.build_timestamp_utc = chrono::Utc::now().to_rfc3339();
|
||||
|
||||
// Clear agents_md if the new definition doesn't want it
|
||||
if !definition.agents_md {
|
||||
ctx.agents_md_files.clear();
|
||||
}
|
||||
|
||||
ctx.render(&self.tool_bridge).await.unwrap_or_default()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use std::num::NonZeroU64;
|
||||
|
||||
/// Standalone function testing the same logic as Agent::should_auto_compact
|
||||
fn should_auto_compact_check(total_tokens: u64, context_window: u64, threshold: u32) -> bool {
|
||||
let cw = NonZeroU64::new(context_window).expect("test context_window must be non-zero");
|
||||
let usage_percent = (total_tokens * 100) / cw.get();
|
||||
usage_percent >= threshold as u64
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_should_auto_compact_below_threshold() {
|
||||
// 80% of 100K window with 85% threshold → false
|
||||
assert!(!should_auto_compact_check(80_000, 100_000, 85));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_should_auto_compact_above_threshold() {
|
||||
// 90% of 100K window with 85% threshold → true
|
||||
assert!(should_auto_compact_check(90_000, 100_000, 85));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_should_auto_compact_at_threshold() {
|
||||
// Exactly 85% of 100K window with 85% threshold → true
|
||||
assert!(should_auto_compact_check(85_000, 100_000, 85));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_should_auto_compact_empty_usage() {
|
||||
// 0 tokens used → false
|
||||
assert!(!should_auto_compact_check(0, 100_000, 85));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_should_auto_compact_100_percent_threshold() {
|
||||
// 100% threshold → only triggers when fully used
|
||||
assert!(!should_auto_compact_check(99_999, 100_000, 100));
|
||||
assert!(should_auto_compact_check(100_000, 100_000, 100));
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user