Skip to content

docs: cover features added to cuga-agent in the last 6 months #2

@haroldship

Description

@haroldship

Summary

Audit of this docs repo against cuga-project/cuga-agent (README, code, src/cuga/settings.toml, and merged PRs over the last ~6 months) shows several major capabilities have been added to the agent but never made it into the documentation. This issue tracks the gap and the planned doc PR.

Missing pages / sections

New feature areas with no doc coverage

  • Knowledge Base & Doclingagent.knowledge API, enable_knowledge=True, cuga start demo_knowledge, session vs agent scope, supported document types (cuga-agent feat 213502c, 2026-04-07).
  • Context Summarization ([context_summarization]) — trigger_fraction, keep_last_n_messages, summarization_model, custom prompt (cuga-agent PR #61, 2026-04-13).
  • Vault & multi-backend secrets ([secrets]) — mode = local|vault, KV v1/v2, Kubernetes auth, CA bundles, Vault role/mount/path (cuga-agent PRs #48, #79, #80, #167).
  • OIDC / BFF authentication ([auth]) — enabled, authorization_enabled, role mappings, IAM proxy, JWKS cache, session cookie config (cuga-agent PRs #44, #60, #92).
  • OpenLit observability ([observability]) — OTLP endpoint, optional cuga[observability] extras, local docker-compose stack (cuga-agent PR #52, 2026-03-08).
  • Evolve integration ([evolve]) — registry-managed vs direct SSE, lite-mode-only, save_on_success/failure, stdio command (cuga-agent feat e1de23d, 2026-04-12).
  • UI customization ([ui]) — hide_cuga_logo, brand_name (cuga-agent PR #54, 2026-03-08).
  • Storage modes ([storage], [storage.embedding]) — local vs prod, pgvector, embedding provider/model/dim, knowledge persist dir (recent SDK v2 work).
  • Authorization workflow & profile token (cuga-agent PRs #60, #92).
  • Deployment: OpenShift scripts, IBM Cloud GHCR image (cuga-agent feat 1b3bfb6, PR #41).

Partial coverage to complete

  • [supervisor] settings in settings reference (enabled, config_path, agent_approval, pass_variables_a2a); document cuga start demo_supervisor. (SDK page exists, but server/CLI configuration does not.)
  • [policy] settings: enabled, collection_name, policy_db_path, playbook_refine, filesystem_sync, cuga_folder, auto_load_policies (cuga-agent PR #59 + filesystem sync feat).

customization/settings-reference.mdx — missing flags

Under [advanced_features]:

  • force_lite_mode_apps
  • cuga_lite_max_steps
  • cuga_lite_bind_tools_mode / cuga_lite_bind_tools_apps / cuga_lite_bind_tools_include_find_tools
  • cuga_lite_nl_auto_continue
  • cuga_lite_enable_few_shots
  • enable_todos
  • reflection_enabled
  • tool_call_timeout
  • execution_output_max_length
  • sub_task_keep_last_n
  • code_executor_keep_last_n
  • path_segment_index
  • force_autonomous_mode
  • appworld_final_answer_plain

New sections entirely missing from settings reference:

  • [supervisor], [storage], [storage.embedding], [policy], [service], [secrets], [auth], [ui], [context_summarization], [connections], [observability], [evolve].

Server ports out of date

settings-reference.mdx doesn't list these ports that exist in settings.toml: filesystem_mcp (8112), docs_mcp (8113), oak_health_api (8090). Also demo_server_startup_max_retries.

Stale / incorrect content

  • Memory (customization/memory.mdx and settings-reference.mdx): enable_memory, enable_fact, memory_provider = mem0, and the memory = 8888 port are documented as live, but cuga-agent PR #153 (2026-04-23, "feat: remove memory support for cuga classic") removed this. Page should get a deprecation banner and the settings should be removed from the reference.
  • Architecture overview (architecture-section/overview.mdx): the file ends with leftover AI-assistant prompt text — "👉 Next step could be to include an inline Mermaid diagram… Want me to add that Mermaid diagram block…?" — needs removal.
  • LLM config (customization/llm-config.mdx): Groq snippet has typo GENT_SETTING_CONFIG (missing leading A).
  • Quick Start (getting-started/index.mdx): tech-stack accordion lists "Selenium/Playwright" — current code uses Playwright (+ Chromium browser extension). Selenium reference is misleading.
  • The force_lite_mode_apps example in cuga-agent README/settings includes ["knowledge"]; this needs a corresponding mention once the Knowledge page lands.

SDK page updates

  • sdk/cuga_agent.mdx: add enable_knowledge constructor arg, document agent.knowledge namespace (ingest, search, list_documents, scopes), and the aclose() method.

Plan

A single PR ("docs: cover recent cuga-agent features") will:

  1. Add new pages: Knowledge, Vault/Secrets, Authentication, Observability (OpenLit), Context Summarization, Evolve, UI customization, Storage backends.
  2. Expand customization/settings-reference.mdx to cover every section/flag in current settings.toml.
  3. Document demo_supervisor / demo_knowledge start commands.
  4. Add deprecation banner to memory page; remove memory flags/port from settings reference.
  5. Fix the architecture artifact, the Groq typo, and the Selenium reference.
  6. Update the SDK CugaAgent page with knowledge integration.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions