Skip to content
This repository was archived by the owner on Jun 3, 2026. It is now read-only.

Commit d3d4d90

Browse files
committed
docs: update documentation for v1.4.0 features
1 parent 1ebef6f commit d3d4d90

4 files changed

Lines changed: 59 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ Detailed guides are available in the `docs/` directory:
103103
- [Getting Started](docs/getting_started.md)
104104
- [Slash Command Reference](docs/COMMANDS.md)
105105
- [Tool Reference](docs/tools.md)
106+
- [Memory Management](docs/memory.md)
106107
- [Sandbox Environment](docs/sandbox.md)
107108
- [Configuring Providers](docs/configuration.md)
108109

docs/configuration.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,18 @@ You can manage your providers without leaving the TUI using slash commands:
4848
```bash
4949
/config reorder "Groq Backup" up
5050
```
51+
52+
## Economics & Budgeting
53+
54+
Plexir tracks real-time token usage and estimates costs based on the active provider's pricing.
55+
56+
### Set a session budget
57+
To prevent unexpected costs during long sessions, you can set a maximum dollar amount for the current session. If exceeded, Plexir will stop generating and notify you.
58+
```bash
59+
/config budget 0.50
60+
```
61+
*Set to `0` to disable the limit.*
62+
63+
### View current usage
64+
Usage metrics (Tokens and Estimated Cost) are always visible in the **System Status** sidebar.
65+

docs/memory.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Memory & Context Management
2+
3+
Plexir uses advanced techniques to manage long-running conversations, ensuring the model remains coherent even as the history grows.
4+
5+
## 🔄 Rolling Summarization
6+
7+
When a conversation history becomes too large (exceeding 40 messages), Plexir automatically triggers **Rolling Summarization**.
8+
9+
1. **How it works**: Plexir identifies older, unpinned messages and uses the primary LLM to condense them into a concise "BACKGROUND SUMMARY."
10+
2. **Context Preservation**: This summary is injected at the start of the conversation, allowing the model to remember high-level decisions and context while clearing out detailed token-heavy noise.
11+
3. **Automatic**: This happens in the background without user intervention.
12+
13+
## 📌 Message Pinning
14+
15+
You can manually protect critical messages from being summarized or pruned using **Context Pinning**.
16+
17+
### Pin a message
18+
Use the `/session pin` command followed by the message number (visible in the history or logs).
19+
```bash
20+
/session pin 5
21+
```
22+
*Pinned messages will be highlighted and are exempt from the summarization process.*
23+
24+
### Unpin a message
25+
```bash
26+
/session unpin 5
27+
```
28+
29+
## 🧠 Distillation (Failover)
30+
31+
During a **Provider Failover** (e.g., Gemini Primary hitting a quota), Plexir uses a "Distillation" process to transfer only the most essential recent context to the backup provider. This ensures a smooth transition with minimal latency and token waste.

docs/tools.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,18 @@ Plexir agents are equipped with a powerful set of tools to interact with the sys
3232

3333
## MCP & Extensibility
3434

35-
| Tool | Description | Critical? |
36-
| :--- | :--- | :--- |
37-
| `mcp_<server>_resources` | List or read resources (schemas, logs, etc.) from an MCP server. | No |
35+
Plexir dynamically integrates with Model Context Protocol (MCP) servers.
36+
37+
| Tool | Description |
38+
| :--- | :--- |
39+
| `mcp_<server>_resources` | List or read static resources and dynamic URI templates from the server. |
40+
| `mcp_<server>_prompts` | List and retrieve reusable prompt templates (expert configurations) from the server. |
41+
42+
### How it works
43+
When you add an MCP server via `/config add`, Plexir automatically queries its capabilities and registers these tools if supported by the server.
44+
- **Resources**: Can be database schemas, log files, or internal documentation.
45+
- **Prompts**: Pre-defined system instructions optimized for specific tasks like code review or documentation generation.
46+
3847

3948
## Web & Information
4049

0 commit comments

Comments
 (0)