Skip to content

Commit 21f6379

Browse files
tpaetpae
committed
updated docs
1 parent d8a02c1 commit 21f6379

File tree

2 files changed

+80
-19
lines changed

2 files changed

+80
-19
lines changed

‎README.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Osaurus is an all-in-one LLM server for macOS. It combines:
4646
- **MCP Server** — Expose tools to AI agents via Model Context Protocol
4747
- **Remote MCP Providers** — Connect to external MCP servers and aggregate their tools
4848
- **Plugin System** — Extend functionality with community and custom tools
49+
- **Personas** — Create custom AI assistants with unique prompts, tools, and visual themes
4950
- **Developer Tools** — Built-in insights and server explorer for debugging
5051
- **Apple Foundation Models** — Use the system model on macOS 26+ (Tahoe)
5152

@@ -60,6 +61,7 @@ Osaurus is an all-in-one LLM server for macOS. It combines:
6061
| **MCP Server** | Connect to Cursor, Claude Desktop, and other MCP clients |
6162
| **Remote MCP Providers** | Aggregate tools from external MCP servers |
6263
| **Tools & Plugins** | Browser automation, file system, git, web search, and more |
64+
| **Personas** | Custom AI assistants with unique prompts, tools, and themes |
6365
| **Custom Themes** | Create, import, and export themes with full color customization |
6466
| **Developer Tools** | Request insights, API explorer, and live endpoint testing |
6567
| **Menu Bar Chat** | Chat overlay with session history, context tracking (`⌘;`) |
@@ -189,6 +191,27 @@ osaurus tools create MyPlugin --language swift
189191

190192
See the [Plugin Authoring Guide](docs/PLUGIN_AUTHORING.md) for details.
191193

194+
### Personas
195+
196+
Create custom AI assistant personalities with unique behaviors, capabilities, and styles.
197+
198+
Each persona can have:
199+
200+
- **Custom System Prompt** — Define unique instructions and personality
201+
- **Tool Configuration** — Enable or disable specific tools per persona
202+
- **Visual Theme** — Assign a custom theme that activates with the persona
203+
- **Model & Generation Settings** — Set default model, temperature, and max tokens
204+
- **Import/Export** — Share personas as JSON files
205+
206+
Use cases:
207+
208+
- **Code Assistant** — Focused on programming with code-related tools enabled
209+
- **Daily Planner** — Calendar and reminders integration
210+
- **Research Helper** — Web search and note-taking tools enabled
211+
- **Creative Writer** — Higher temperature, no tool access for pure generation
212+
213+
Access via Management window (`⌘ Shift M`) → **Personas**.
214+
192215
### Developer Tools
193216

194217
Built-in tools for debugging and development:

‎docs/FEATURES.md‎

Lines changed: 57 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,26 @@ Canonical reference for all Osaurus features, their status, and documentation.
88

99
## Feature Matrix
1010

11-
| Feature | Status | README Section | Documentation | Code Location |
12-
| -------------------------------- | --------- | ------------------ | ----------------------------- | -------------------------------------------------------------------------- |
13-
| Local LLM Server (MLX) | Stable | "Key Features" | OpenAI_API_GUIDE.md | Services/MLXService.swift, Services/ModelRuntime/ |
14-
| Remote Providers | Stable | "Key Features" | REMOTE_PROVIDERS.md | Services/RemoteProviderManager.swift, Services/RemoteProviderService.swift |
15-
| Remote MCP Providers | Stable | "Key Features" | REMOTE_MCP_PROVIDERS.md | Services/MCPProviderManager.swift, Tools/MCPProviderTool.swift |
16-
| MCP Server | Stable | "MCP Server" | (in README) | Networking/OsaurusServer.swift, Services/MCPServerManager.swift |
17-
| Tools & Plugins | Stable | "Tools & Plugins" | PLUGIN_AUTHORING.md | Tools/, Managers/PluginManager.swift |
18-
| Developer Tools: Insights | Stable | "Developer Tools" | DEVELOPER_TOOLS.md | Views/InsightsView.swift, Services/InsightsService.swift |
19-
| Developer Tools: Server Explorer | Stable | "Developer Tools" | DEVELOPER_TOOLS.md | Views/ServerView.swift |
20-
| Apple Foundation Models | macOS 26+ | "What is Osaurus?" | (in README) | Services/FoundationModelService.swift |
21-
| Menu Bar Chat | Stable | "Highlights" | (in README) | Views/ChatView.swift, Views/ChatOverlayView.swift |
22-
| Chat Session Management | Stable | "Highlights" | (in README) | Managers/ChatSessionsManager.swift, Models/ChatSessionData.swift |
23-
| Custom Themes | Stable | "Highlights" | (in README) | Views/ThemesView.swift, Views/Components/ThemeEditorView.swift |
24-
| Model Manager | Stable | "Highlights" | (in README) | Views/ModelDownloadView.swift, Services/HuggingFaceService.swift |
25-
| Shared Configuration | Stable | - | SHARED_CONFIGURATION_GUIDE.md | Services/SharedConfigurationService.swift |
26-
| OpenAI API Compatibility | Stable | "API Endpoints" | OpenAI_API_GUIDE.md | Networking/HTTPHandler.swift, Models/OpenAIAPI.swift |
27-
| Anthropic API Compatibility | Stable | "API Endpoints" | (in README) | Networking/HTTPHandler.swift, Models/AnthropicAPI.swift |
28-
| Ollama API Compatibility | Stable | "API Endpoints" | (in README) | Networking/HTTPHandler.swift |
29-
| CLI | Stable | "CLI Reference" | (in README) | Packages/OsaurusCLI/ |
11+
| Feature | Status | README Section | Documentation | Code Location |
12+
| -------------------------------- | --------- | ------------------ | ----------------------------- | ----------------------------------------------------------------------------- |
13+
| Local LLM Server (MLX) | Stable | "Key Features" | OpenAI_API_GUIDE.md | Services/MLXService.swift, Services/ModelRuntime/ |
14+
| Remote Providers | Stable | "Key Features" | REMOTE_PROVIDERS.md | Services/RemoteProviderManager.swift, Services/RemoteProviderService.swift |
15+
| Remote MCP Providers | Stable | "Key Features" | REMOTE_MCP_PROVIDERS.md | Services/MCPProviderManager.swift, Tools/MCPProviderTool.swift |
16+
| MCP Server | Stable | "MCP Server" | (in README) | Networking/OsaurusServer.swift, Services/MCPServerManager.swift |
17+
| Tools & Plugins | Stable | "Tools & Plugins" | PLUGIN_AUTHORING.md | Tools/, Managers/PluginManager.swift |
18+
| Personas | Stable | "Personas" | (in README) | Managers/PersonaManager.swift, Models/Persona.swift, Views/PersonasView.swift |
19+
| Developer Tools: Insights | Stable | "Developer Tools" | DEVELOPER_TOOLS.md | Views/InsightsView.swift, Services/InsightsService.swift |
20+
| Developer Tools: Server Explorer | Stable | "Developer Tools" | DEVELOPER_TOOLS.md | Views/ServerView.swift |
21+
| Apple Foundation Models | macOS 26+ | "What is Osaurus?" | (in README) | Services/FoundationModelService.swift |
22+
| Menu Bar Chat | Stable | "Highlights" | (in README) | Views/ChatView.swift, Views/ChatOverlayView.swift |
23+
| Chat Session Management | Stable | "Highlights" | (in README) | Managers/ChatSessionsManager.swift, Models/ChatSessionData.swift |
24+
| Custom Themes | Stable | "Highlights" | (in README) | Views/ThemesView.swift, Views/Components/ThemeEditorView.swift |
25+
| Model Manager | Stable | "Highlights" | (in README) | Views/ModelDownloadView.swift, Services/HuggingFaceService.swift |
26+
| Shared Configuration | Stable | - | SHARED_CONFIGURATION_GUIDE.md | Services/SharedConfigurationService.swift |
27+
| OpenAI API Compatibility | Stable | "API Endpoints" | OpenAI_API_GUIDE.md | Networking/HTTPHandler.swift, Models/OpenAIAPI.swift |
28+
| Anthropic API Compatibility | Stable | "API Endpoints" | (in README) | Networking/HTTPHandler.swift, Models/AnthropicAPI.swift |
29+
| Ollama API Compatibility | Stable | "API Endpoints" | (in README) | Networking/HTTPHandler.swift |
30+
| CLI | Stable | "CLI Reference" | (in README) | Packages/OsaurusCLI/ |
3031

3132
---
3233

@@ -43,6 +44,7 @@ Canonical reference for all Osaurus features, their status, and documentation.
4344
│ │ ├── ModelDownloadView (Models) │
4445
│ │ ├── RemoteProvidersView (Providers) │
4546
│ │ ├── ToolsManagerView (Tools) │
47+
│ │ ├── PersonasView (Personas) │
4648
│ │ ├── ThemesView (Themes) │
4749
│ │ ├── InsightsView (Developer: Insights) │
4850
│ │ ├── ServerView (Developer: Server Explorer) │
@@ -61,6 +63,8 @@ Canonical reference for all Osaurus features, their status, and documentation.
6163
│ │ ├── ToolRegistry │
6264
│ │ ├── PluginManager │
6365
│ │ └── MCPProviderTool (Wrapped remote MCP tools) │
66+
│ ├── Personas │
67+
│ │ └── PersonaManager (Persona lifecycle and active persona) │
6468
│ └── Utilities │
6569
│ ├── InsightsService (Request logging) │
6670
│ ├── HuggingFaceService (Model downloads) │
@@ -234,6 +238,40 @@ Canonical reference for all Osaurus features, their status, and documentation.
234238

235239
---
236240

241+
### Personas
242+
243+
**Purpose:** Create custom AI assistant personalities with unique behaviors, capabilities, and visual styles.
244+
245+
**Components:**
246+
247+
- `Models/Persona.swift` — Persona data model with export/import support
248+
- `Models/PersonaStore.swift` — Persona persistence (JSON files)
249+
- `Managers/PersonaManager.swift` — Persona lifecycle and active persona management
250+
- `Views/PersonasView.swift` — Persona gallery and management UI
251+
252+
**Features:**
253+
254+
- **Custom System Prompts** — Define unique instructions for each persona
255+
- **Tool Configuration** — Enable or disable specific tools per persona
256+
- **Visual Themes** — Assign a custom theme that activates with the persona
257+
- **Generation Settings** — Configure default model, temperature, and max tokens
258+
- **Import/Export** — Share personas as JSON files for backup or sharing
259+
- **Live Switching** — Click to activate a persona, theme updates automatically
260+
261+
**Persona Properties:**
262+
| Property | Description |
263+
|----------|-------------|
264+
| `name` | Display name (required) |
265+
| `description` | Brief description of the persona |
266+
| `systemPrompt` | Instructions prepended to all chats |
267+
| `enabledTools` | Map of tool name → enabled/disabled |
268+
| `themeId` | Optional custom theme to apply |
269+
| `defaultModel` | Optional model ID for this persona |
270+
| `temperature` | Optional temperature override |
271+
| `maxTokens` | Optional max tokens override |
272+
273+
---
274+
237275
### Chat Session Management
238276

239277
**Purpose:** Persist and manage chat conversations with per-session configuration.

0 commit comments

Comments
 (0)