Skip to content

Commit dbbc57b

Browse files
committed
docs: reframe public docs around KOS philosophy
1 parent d04d24b commit dbbc57b

8 files changed

Lines changed: 349 additions & 437 deletions

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ KOS2 starts from the `obsidian-copilot` codebase, but the product direction is d
1313

1414
![KOS2 screenshot](images/product-ui-screenshot.png)
1515

16+
If you want the mental model behind the product, read [KOS Philosophy](docs/kos-philosophy.md).
17+
1618
## Why KOS2
1719

1820
Most AI note tools are good at answering questions and bad at helping you run an operating system for your own work.

docs/agent-mode-and-tools.md

Lines changed: 50 additions & 155 deletions
Original file line numberDiff line numberDiff line change
@@ -1,190 +1,85 @@
11
# Agent Mode and Tools
22

3-
Copilot Plus includes an **autonomous agent** that can reason step-by-step and decide which tools to use to answer your question. Instead of you specifying every step, the agent figures out what to do on its own.
3+
KOS2 includes an agent path for more complex note and web tasks.
44

5-
This feature requires a [Copilot Plus](copilot-plus-and-self-host.md) license.
5+
This document is intentionally lighter than the old upstream “Copilot Plus” explanation. It describes what KOS2 can do now and where setup is still required.
66

7-
---
7+
## What the KOS2 Agent Is For
88

9-
## Overview
9+
Use the agent when the job is more than a single answer and needs a short workflow:
1010

11-
When the autonomous agent is enabled, Copilot can:
11+
- search the vault and inspect relevant notes
12+
- search the web when current information matters
13+
- create or edit notes with previewable changes
14+
- combine evidence into a useful response
1215

13-
1. Break down your request into sub-tasks
14-
2. Use tools to gather information (search your vault, search the web, read a note)
15-
3. Create or edit notes
16-
4. Combine results and give you a comprehensive answer
16+
If the task is simple, normal chat is usually enough.
1717

18-
**Example**: Ask "What did I work on last week?" and the agent will automatically search your vault for dated notes from the past 7 days, read the relevant ones, and summarize your week.
18+
## What the Agent Can Use
1919

20-
---
20+
### Core note tools
2121

22-
## Enabling Agent Mode
22+
- vault search
23+
- read note
24+
- write to file
25+
- edit file
2326

24-
1. Go to **Settings → Copilot → Plus**
25-
2. Turn on **Enable Autonomous Agent**
27+
These are the tools that matter most for KOS-style note work.
2628

27-
The agent activates automatically when you're in **Copilot Plus** mode. You don't need to do anything special — just ask your question.
29+
### Optional web tool
2830

29-
### Max Iterations
31+
- web search
3032

31-
The agent works in iteration cycles (think → use a tool → think → use a tool → answer). You can control the maximum number of iterations before the agent stops:
33+
In KOS2 this should be treated as optional. It is not the default center of gravity. Web search is most useful when the task clearly depends on current external information.
3234

33-
- **Default**: 4 iterations
34-
- **Maximum**: 16 iterations
35-
- **Setting**: **Settings → Copilot → Plus → Autonomous Agent Max Iterations**
35+
### Optional transcript tool
3636

37-
The agent also has a maximum runtime of 5 minutes per response, regardless of iteration count.
37+
- YouTube transcription
3838

39-
---
39+
This now depends on explicit setup. KOS2 surfaces transcript setup in the plugin and currently points users toward:
4040

41-
## Available Tools
41+
- `Supadata` for transcript API access
42+
- local preparation with `yt-dlp` and `whisper`
4243

43-
Copilot Plus has 13 built-in tools. Some are always active; others can be enabled or disabled.
44+
### Experimental desktop controls
4445

45-
### Always-Enabled Tools
46+
Some inherited desktop or CLI-oriented tools still exist in the codebase, but they are not the primary product story and should be treated as advanced or experimental.
4647

47-
These tools are always available and cannot be disabled:
48+
## Privacy And Local Defaults
4849

49-
#### Get Current Time
50+
If you want the default agent path to stay local:
5051

51-
Gets the current time in any timezone. Useful for time-aware queries like "what should I do today?"
52+
1. enable `Privacy (local) Mode`
53+
2. set the default chat model to `KOS2 Local Agent`
54+
3. keep embeddings on a local Ollama model
5255

53-
#### Get Time Range
56+
That gives you a cleaner split:
5457

55-
Converts natural time expressions (like "last week" or "yesterday") into exact date ranges. Usually called automatically before a time-based vault search.
58+
- local model for note work
59+
- optional cloud only when you deliberately want web search or web fetch
5660

57-
#### Get Time Info
61+
## File Editing Behavior
5862

59-
Converts an epoch timestamp to a human-readable date and time.
63+
When the agent writes or edits notes, the intended path is preview-first note operations rather than silent mutation.
6064

61-
#### Convert Timezones
65+
Use the agent for:
6266

63-
Converts a time from one timezone to another. Ask: "What time is 3pm EST in Tokyo?"
67+
- creating a note draft
68+
- updating an existing note
69+
- turning rough material into a clearer artifact
6470

65-
#### Read Note
71+
Treat it as an operator with guardrails, not as an invisible background process.
6672

67-
Reads the content of a specific note. The agent uses this to inspect a note it found via search, or that you mentioned explicitly. Works on large notes by reading them in chunks.
73+
## When To Use Which Mode
6874

69-
#### File Tree
70-
71-
Browses the file structure of your vault. The agent uses this to find folder paths before creating new notes or to count files in a folder.
72-
73-
#### Tag List
74-
75-
Lists all tags in your vault with usage statistics. Useful for tag reorganization or finding notes by tag patterns.
76-
77-
#### Update Memory
78-
79-
Saves information to your memory when you explicitly ask the AI to remember something. See [Copilot Plus and Self-Host](copilot-plus-and-self-host.md#memory-system) for details.
80-
81-
> **Requires**: **Settings → Copilot → Plus → Reference Saved Memories** must be enabled. If this setting is off, the tool is not registered and memory commands will not work.
82-
83-
### Configurable Tools
84-
85-
These tools can be individually enabled or disabled in **Settings → Copilot → Plus → Tool Settings**:
86-
87-
#### Vault Search
88-
89-
Searches your vault notes by content. The agent uses this to find notes relevant to your question.
90-
91-
- **Trigger**: Automatically for vault-related questions, or explicitly with `@vault`
92-
- **Uses**: Both semantic search (if enabled) and lexical search
93-
94-
#### Web Search
95-
96-
Searches the internet for current information.
97-
98-
- **Trigger**: Automatically when your question implies web/online content, or explicitly with `@websearch` or `@web`
99-
- **Requires**: A web search service configured (Firecrawl or Perplexity in self-host mode, or handled by Plus)
100-
101-
#### Write to File
102-
103-
Creates a new note or overwrites an existing one entirely.
104-
105-
- **Trigger**: Automatically for "create a note" requests, or explicitly with `@composer` (available in both Copilot Plus and Projects mode)
106-
- **Behavior**: Shows a preview of the content before writing. You can review and accept or reject the change.
107-
- **Auto-accept**: Enable **Settings → Copilot → Plus → Auto-accept edits** to skip the preview
108-
109-
#### Replace in File
110-
111-
Makes targeted changes to an existing note using search-and-replace blocks.
112-
113-
- **Use case**: Small edits (adding a bullet, updating a section) — more precise than rewriting the whole note
114-
- **Behavior**: Shows a diff preview before applying the change
115-
- **Auto-accept**: Same setting as Write to File
116-
117-
#### YouTube Transcription
118-
119-
Fetches the transcript of a YouTube video.
120-
121-
- **Trigger**: Automatically when you paste a YouTube URL in your message
122-
- **No extra setup needed**: Just include the URL in your message
123-
- **Self-host option**: Use your own Supadata API key for transcription in self-host mode
124-
125-
---
126-
127-
## Tool Settings
128-
129-
Go to **Settings → Copilot → Plus → Tool Settings** to:
130-
131-
- See all available tools
132-
- Enable or disable individual configurable tools
133-
- View what each tool does
134-
135-
---
136-
137-
## Using Tools Explicitly
138-
139-
While the agent automatically decides when to use tools, you can also trigger them explicitly with @-mentions:
140-
141-
```
142-
@vault find all notes about my reading list
143-
@websearch what is the latest version of Python?
144-
@composer create a new meeting notes template
145-
@memory remember that I prefer bullet points for lists
146-
```
147-
148-
See [Context and Mentions](context-and-mentions.md) for the full @-mention reference.
149-
150-
---
151-
152-
## Tool Call Indicators
153-
154-
While the agent is working, the chat shows status indicators for each tool call:
155-
156-
- "Reading files"
157-
- "Searching the web"
158-
- "Reading file tree"
159-
- "Compacting"
160-
161-
This lets you see what the agent is doing as it works.
162-
163-
---
164-
165-
## File Editing: Preview and Diff
166-
167-
When the agent uses **Write to File** or **Replace in File**, it shows a preview before making changes:
168-
169-
- **Split view**: Before/after shown side by side
170-
- **Side-by-side view**: Changes highlighted inline
171-
172-
You can choose your preferred diff view in **Settings → Copilot → Plus → Diff View Mode**.
173-
174-
Review the proposed change and click:
175-
176-
- **Accept** — Apply the change to your note
177-
- **Reject** — Discard without making any changes
178-
- **Revert** — Undo a change that was already accepted
179-
180-
### Auto-Accept Edits
181-
182-
If you trust the agent and don't want to review every file change, enable **Auto-accept edits** in **Settings → Copilot → Plus**. File changes will be applied immediately without a confirmation step.
183-
184-
---
75+
- `Chat`: simple reasoning, rewriting, summarization, or conversation
76+
- `Knowledge`: when note retrieval matters and you want search-backed help
77+
- `KOS2 Agent`: when the request involves note work plus tools plus a small workflow
78+
- `Projects`: inherited workspace isolation when you need separated chat state
18579

18680
## Related
18781

188-
- [Copilot Plus and Self-Host](copilot-plus-and-self-host.md) — Licensing and memory
189-
- [Vault Search and Indexing](vault-search-and-indexing.md) — How vault search works
190-
- [Context and Mentions](context-and-mentions.md) — @-mention triggers for tools
82+
- [Getting Started](getting-started.md)
83+
- [KOS Philosophy](kos-philosophy.md)
84+
- [Vault Search and Indexing](vault-search-and-indexing.md)
85+
- [Custom Commands](custom-commands.md)

docs/chat-interface.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
# Chat Interface
22

3-
The Copilot chat panel is the main way you interact with AI in Obsidian. This guide covers everything about the chat UI: modes, message controls, history, settings, and advanced features like auto-compact.
3+
The KOS2 chat panel is the main way you interact with the plugin in Obsidian. This guide covers the current chat UI: modes, message controls, history, settings, and the workflow-oriented surfaces that matter most.
44

55
---
66

77
## Chat Modes
88

9-
Copilot offers four modes. You can switch between them using the mode selector at the top of the chat panel.
9+
KOS2 currently exposes four top-level paths. You can switch between them using the selector at the top of the chat panel.
1010

1111
### Chat
1212

1313
General-purpose conversation. Good for writing, brainstorming, summarizing, or any task where you want to talk to an AI. Your currently open note and selected text are automatically included as context.
1414

15-
### Vault QA (Basic)
15+
### Knowledge
1616

17-
Ask questions about your vault content. Copilot uses lexical search (keyword matching) to find relevant notes and passes them as context to the AI. No indexing required. Good for quick questions about your notes.
17+
Ask questions about your vault content. KOS2 uses lexical search by default and semantic search when you enable a local embedding model and build the index.
1818

19-
### Copilot Plus
19+
### KOS2 Agent
2020

21-
The most powerful mode. Requires a [Copilot Plus](copilot-plus-and-self-host.md) license. Combines Chat and Vault QA with an autonomous agent that can:
21+
The workflow-heavy path. Use this when the task needs tools instead of only a direct answer:
2222

2323
- Search your vault and the web
2424
- Read and edit notes
25-
- Remember things across conversations
26-
- Use a growing set of tools automatically
25+
- Use the available tools automatically
26+
27+
Web and transcript capabilities still depend on explicit setup.
2728

2829
### Projects (alpha)
2930

@@ -71,7 +72,7 @@ Each AI response has action buttons:
7172

7273
### Autosave
7374

74-
By default, Copilot automatically saves your conversations as markdown files in your vault. Each saved chat appears in the `copilot/copilot-conversations/` folder.
75+
By default, KOS2 automatically saves your conversations as markdown files in your vault. The save path now lives under the KOS2 system root instead of the old upstream folder layout.
7576

7677
You can turn off autosave in Settings → Basic. When you start a new chat, any unsaved conversation is saved automatically.
7778

@@ -93,7 +94,7 @@ All three variables are required. You can customize the format in Settings → B
9394

9495
### AI-Generated Titles
9596

96-
When **Generate AI chat title on save** is enabled (default), Copilot asks the AI to generate a short, descriptive title for the conversation when saving. When disabled, the first 10 words of your first message are used instead.
97+
When **Generate AI chat title on save** is enabled (default), KOS2 asks the AI to generate a short, descriptive title for the conversation when saving. When disabled, the first 10 words of your first message are used instead.
9798

9899
### Loading Previous Chats
99100

@@ -119,7 +120,7 @@ Click the **gear icon** inside the chat panel to open per-session settings. Thes
119120

120121
## Token Counter
121122

122-
Copilot shows a token count indicator at the bottom of the chat. This estimates how many tokens are being used by your current context. Useful for knowing when you're approaching context limits.
123+
KOS2 can show a token count indicator at the bottom of the chat. This estimates how many tokens are being used by your current context. Useful when you're approaching context limits, but it is no longer a primary UX element.
123124

124125
---
125126

@@ -135,13 +136,13 @@ When auto-compact triggers, you'll see a "Compacting" indicator in the chat. The
135136

136137
## Suggested Prompts
137138

138-
When starting a new chat, Copilot may show suggested prompts based on your active note or previous conversations. You can enable or disable this in Settings → Basic → **Show suggested prompts**.
139+
When starting a new chat, KOS2 may show workflow starter paths instead of generic prompt spam. You can still enable or disable the prompt surface from settings if needed.
139140

140141
## Relevant Notes
141142

142-
Copilot can display a list of notes related to your currently active note in the chat panel. This helps surface notes you might want to reference without manually searching.
143+
KOS2 can display a list of notes related to your currently active note in the chat panel. This helps surface notes you might want to reference without manually searching.
143144

144-
Enable in **Settings → Copilot → Basic → Relevant Notes** (on by default).
145+
Enable in `Settings -> KOS2 -> Setup -> Relevant Notes` if you want it visible.
145146

146147
## Saving a Chat Manually
147148

@@ -157,13 +158,14 @@ Click the **pencil/new chat icon** to start a fresh conversation. This:
157158
2. Clears the chat window
158159
3. Resets the context to your currently active note
159160

160-
You can also use the command palette: **New Copilot Chat**.
161+
You can also use the command palette: **New KOS2 Chat**.
161162

162163
---
163164

164165
## Related
165166

166167
- [Context and Mentions](context-and-mentions.md) — Control what context the AI sees
167168
- [System Prompts](system-prompts.md) — Customize AI behavior with system prompts
168-
- [Agent Mode and Tools](agent-mode-and-tools.md) — What Plus mode can do
169+
- [Agent Mode and Tools](agent-mode-and-tools.md) — What the KOS2 agent can do
170+
- [KOS Philosophy](kos-philosophy.md) — Why the product is shaped around workflow paths
169171
- [Projects](projects.md) — Isolated workspaces with separate histories

0 commit comments

Comments
 (0)