@tecet/ollm 0.1.4-b → 0.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (66) hide show
  1. package/docs/README.md +3 -410
  2. package/package.json +2 -2
  3. package/docs/Context/CheckpointFlowDiagram.md +0 -673
  4. package/docs/Context/ContextArchitecture.md +0 -898
  5. package/docs/Context/ContextCompression.md +0 -1102
  6. package/docs/Context/ContextManagment.md +0 -750
  7. package/docs/Context/Index.md +0 -209
  8. package/docs/Context/README.md +0 -390
  9. package/docs/DevelopmentRoadmap/Index.md +0 -238
  10. package/docs/DevelopmentRoadmap/OLLM-CLI_Releases.md +0 -419
  11. package/docs/DevelopmentRoadmap/PlanedFeatures.md +0 -448
  12. package/docs/DevelopmentRoadmap/README.md +0 -174
  13. package/docs/DevelopmentRoadmap/Roadmap.md +0 -572
  14. package/docs/DevelopmentRoadmap/RoadmapVisual.md +0 -372
  15. package/docs/Hooks/Architecture.md +0 -885
  16. package/docs/Hooks/Index.md +0 -244
  17. package/docs/Hooks/KeyboardShortcuts.md +0 -248
  18. package/docs/Hooks/Protocol.md +0 -817
  19. package/docs/Hooks/README.md +0 -403
  20. package/docs/Hooks/UserGuide.md +0 -1483
  21. package/docs/Hooks/VisualGuide.md +0 -598
  22. package/docs/Index.md +0 -506
  23. package/docs/Installation.md +0 -586
  24. package/docs/Introduction.md +0 -367
  25. package/docs/LLM Models/Index.md +0 -239
  26. package/docs/LLM Models/LLM_GettingStarted.md +0 -748
  27. package/docs/LLM Models/LLM_Index.md +0 -701
  28. package/docs/LLM Models/LLM_MemorySystem.md +0 -337
  29. package/docs/LLM Models/LLM_ModelCompatibility.md +0 -499
  30. package/docs/LLM Models/LLM_ModelsArchitecture.md +0 -933
  31. package/docs/LLM Models/LLM_ModelsCommands.md +0 -839
  32. package/docs/LLM Models/LLM_ModelsConfiguration.md +0 -1094
  33. package/docs/LLM Models/LLM_ModelsList.md +0 -1071
  34. package/docs/LLM Models/LLM_ModelsList.md.backup +0 -400
  35. package/docs/LLM Models/README.md +0 -355
  36. package/docs/MCP/MCP_Architecture.md +0 -1086
  37. package/docs/MCP/MCP_Commands.md +0 -1111
  38. package/docs/MCP/MCP_GettingStarted.md +0 -590
  39. package/docs/MCP/MCP_Index.md +0 -524
  40. package/docs/MCP/MCP_Integration.md +0 -866
  41. package/docs/MCP/MCP_Marketplace.md +0 -160
  42. package/docs/MCP/README.md +0 -415
  43. package/docs/Prompts System/Architecture.md +0 -760
  44. package/docs/Prompts System/Index.md +0 -223
  45. package/docs/Prompts System/PromptsRouting.md +0 -1047
  46. package/docs/Prompts System/PromptsTemplates.md +0 -1102
  47. package/docs/Prompts System/README.md +0 -389
  48. package/docs/Prompts System/SystemPrompts.md +0 -856
  49. package/docs/Quickstart.md +0 -535
  50. package/docs/Tools/Architecture.md +0 -884
  51. package/docs/Tools/GettingStarted.md +0 -624
  52. package/docs/Tools/Index.md +0 -216
  53. package/docs/Tools/ManifestReference.md +0 -141
  54. package/docs/Tools/README.md +0 -440
  55. package/docs/Tools/UserGuide.md +0 -773
  56. package/docs/Troubleshooting.md +0 -1265
  57. package/docs/UI&Settings/Architecture.md +0 -729
  58. package/docs/UI&Settings/ColorASCII.md +0 -34
  59. package/docs/UI&Settings/Commands.md +0 -755
  60. package/docs/UI&Settings/Configuration.md +0 -872
  61. package/docs/UI&Settings/Index.md +0 -293
  62. package/docs/UI&Settings/Keybinds.md +0 -372
  63. package/docs/UI&Settings/README.md +0 -278
  64. package/docs/UI&Settings/Terminal.md +0 -637
  65. package/docs/UI&Settings/Themes.md +0 -604
  66. package/docs/UI&Settings/UIGuide.md +0 -550
@@ -1,160 +0,0 @@
1
- # Extension Marketplace Guide
2
-
3
- **Finding and Publishing Extensions**
4
-
5
- ---
6
-
7
- ## Finding Extensions
8
-
9
- ### Official Extensions
10
-
11
- **Development Tools:**
12
-
13
- - `ollm-dev-tools` - Code formatting, linting, testing
14
- - `ollm-git` - Git integration and workflows
15
-
16
- **Integrations:**
17
-
18
- - `ollm-github` - GitHub API integration
19
- - `ollm-gitlab` - GitLab API integration
20
- - `ollm-database` - Database tools (PostgreSQL, MySQL, SQLite)
21
-
22
- **Documentation:**
23
-
24
- - `ollm-docs` - Documentation templates and generators
25
-
26
- ### Community Extensions
27
-
28
- Browse community extensions:
29
-
30
- - GitHub Topics (https://github.com/topics/ollm-extension)
31
- - Extension Registry (https://github.com/ollm/extensions)
32
-
33
- ### Search Extensions
34
-
35
- ```bash
36
- # Search by keyword
37
- /extensions search github
38
-
39
- # Search by category
40
- /extensions search --category integration
41
- ```
42
-
43
- ---
44
-
45
- ## Installing Extensions
46
-
47
- ### From Registry
48
-
49
- ```bash
50
- # Install by name
51
- /extensions install github-integration
52
-
53
- # Install specific version
54
- /extensions install github-integration@1.2.0
55
- ```
56
-
57
- ### From URL
58
-
59
- ```bash
60
- # Install from GitHub release
61
- /extensions install https://github.com/user/ext/releases/download/v1.0.0/ext.tar.gz
62
- ```
63
-
64
- ### From File
65
-
66
- ```bash
67
- # Install local file
68
- /extensions install ./my-extension.tar.gz
69
- ```
70
-
71
- ---
72
-
73
- ## Publishing Extensions
74
-
75
- ### 1. Prepare Extension
76
-
77
- - Create manifest.json
78
- - Add README.md
79
- - Add LICENSE
80
- - Test thoroughly
81
- - Package as .tar.gz
82
-
83
- ### 2. Create GitHub Repository
84
-
85
- ```bash
86
- git init
87
- git add .
88
- git commit -m "Initial commit"
89
- git remote add origin https://github.com/user/my-extension
90
- git push -u origin main
91
- ```
92
-
93
- ### 3. Create Release
94
-
95
- ```bash
96
- # Tag version
97
- git tag v1.0.0
98
- git push --tags
99
-
100
- # Create release with archive
101
- gh release create v1.0.0 my-extension-1.0.0.tar.gz
102
- ```
103
-
104
- ### 4. Submit to Registry
105
-
106
- 1. Fork ollm/extensions (https://github.com/ollm/extensions)
107
- 2. Add your extension to registry.json
108
- 3. Submit pull request
109
- 4. Wait for review
110
-
111
- ---
112
-
113
- ## Extension Guidelines
114
-
115
- ### Quality Standards
116
-
117
- **Required:**
118
-
119
- - ✅ Valid manifest.json
120
- - ✅ README.md with usage instructions
121
- - ✅ LICENSE file
122
- - ✅ Semantic versioning
123
- - ✅ Working examples
124
-
125
- **Recommended:**
126
-
127
- - ✅ Comprehensive documentation
128
- - ✅ Test suite
129
- - ✅ Changelog
130
- - ✅ Contributing guidelines
131
-
132
- ### Security Requirements
133
-
134
- **Must:**
135
-
136
- - ✅ Request minimal permissions
137
- - ✅ No malicious code
138
- - ✅ No data collection without disclosure
139
- - ✅ Safe dependencies
140
-
141
- **Must Not:**
142
-
143
- - ❌ Include credentials or secrets
144
- - ❌ Execute arbitrary code
145
- - ❌ Access sensitive files
146
- - ❌ Make undisclosed network requests
147
-
148
- ---
149
-
150
- ## Further Reading
151
-
152
- - [Extension System Overview](3%20projects/OLLM%20CLI/Extensions/README.md)
153
- - [Extension User Guide](3%20projects/OLLM%20CLI/Extensions/user-guide.md)
154
- - [Extension Development Guide](3%20projects/OLLM%20CLI/Extensions/development-guide.md)
155
- - [Manifest Reference](manifest-reference.md)
156
-
157
- ---
158
-
159
- **Last Updated:** 2026-01-16
160
- **Version:** 0.1.0
@@ -1,415 +0,0 @@
1
- # Model Context Protocol (MCP) Documentation
2
-
3
- **Last Updated:** January 26, 2026
4
-
5
- Welcome to the Model Context Protocol (MCP) documentation for OLLM CLI. This section covers MCP integration, servers, commands, and the marketplace.
6
-
7
- ---
8
-
9
- ## 📚 Documentation Overview
10
-
11
- ### Core Documentation
12
-
13
- - **[MCP Index](MCP_Index.md)** - Complete documentation index
14
- - **[Getting Started](MCP_GettingStarted.md)** - Quick start guide
15
- - **[Architecture](MCP_Architecture.md)** - System architecture and design
16
- - **[Integration](MCP_Integration.md)** - Integration guide
17
- - **[Commands](MCP_Commands.md)** - CLI command reference
18
- - **[Marketplace](MCP_Marketplace.md)** - MCP server marketplace
19
-
20
- ---
21
-
22
- ## 🎯 What is MCP?
23
-
24
- The **Model Context Protocol (MCP)** is an open standard that enables LLMs to securely access external tools and data sources. OLLM CLI implements MCP to provide:
25
-
26
- ### 1. **External Tool Integration**
27
-
28
- Connect to MCP servers that provide tools:
29
-
30
- - File system operations
31
- - Database queries
32
- - API integrations
33
- - Web services
34
- - Custom tools
35
-
36
- ### 2. **Resource Access**
37
-
38
- Access external resources:
39
-
40
- - Documentation
41
- - Code repositories
42
- - Databases
43
- - APIs
44
- - File systems
45
-
46
- ### 3. **Prompt Templates**
47
-
48
- Use server-provided prompts:
49
-
50
- - Pre-configured workflows
51
- - Domain-specific templates
52
- - Best practice patterns
53
-
54
- ### 4. **OAuth Authentication**
55
-
56
- Secure authentication for services:
57
-
58
- - GitHub, Google, Slack, etc.
59
- - Token management
60
- - Automatic refresh
61
- - Secure storage
62
-
63
- ---
64
-
65
- ## 📖 Documentation Structure
66
-
67
- ```
68
- docs/MCP/
69
- ├── README.md ← You are here
70
- ├── MCP_Index.md Complete documentation index
71
- ├── MCP_GettingStarted.md Quick start guide
72
- ├── MCP_Architecture.md System architecture
73
- ├── MCP_Integration.md Integration guide
74
- ├── MCP_Commands.md CLI commands
75
- └── MCP_Marketplace.md Server marketplace
76
- ```
77
-
78
- ---
79
-
80
- ## 🎓 Key Concepts
81
-
82
- ### MCP Servers
83
-
84
- External processes that provide tools to LLMs:
85
-
86
- **Server Types:**
87
-
88
- - **Official Servers** - Maintained by MCP team
89
- - **Community Servers** - Third-party servers
90
- - **Custom Servers** - Your own servers
91
-
92
- **Communication:**
93
-
94
- - **stdio** - Standard input/output (most common)
95
- - **SSE** - Server-Sent Events (HTTP streaming)
96
- - **HTTP** - REST API (planned)
97
-
98
- **See:** [Getting Started](MCP_GettingStarted.md#mcp-servers)
99
-
100
- ### MCP Tools
101
-
102
- Functions provided by MCP servers:
103
-
104
- **Tool Discovery:**
105
-
106
- 1. Connect to MCP server
107
- 2. Server lists available tools
108
- 3. Tools registered in tool registry
109
- 4. LLM can call tools
110
-
111
- **Tool Execution:**
112
-
113
- 1. LLM requests tool call
114
- 2. OLLM CLI validates parameters
115
- 3. Request sent to MCP server
116
- 4. Server executes and returns result
117
- 5. Result passed back to LLM
118
-
119
- **See:** [Architecture](MCP_Architecture.md#tool-execution)
120
-
121
- ### OAuth Integration
122
-
123
- Secure authentication for MCP servers:
124
-
125
- **Supported Providers:**
126
-
127
- - GitHub
128
- - Google
129
- - Slack
130
- - Microsoft
131
- - Custom OAuth providers
132
-
133
- **Flow:**
134
-
135
- 1. Server requests OAuth
136
- 2. User authorizes in browser
137
- 3. Token stored securely
138
- 4. Automatic token refresh
139
-
140
- **See:** [Integration](MCP_Integration.md#oauth-setup)
141
-
142
- ### MCP Marketplace
143
-
144
- Discover and install MCP servers:
145
-
146
- **Features:**
147
-
148
- - Browse available servers
149
- - Search by category
150
- - Install with one command
151
- - Automatic configuration
152
- - Update management
153
-
154
- **See:** [Marketplace](MCP_Marketplace.md)
155
-
156
- ---
157
-
158
- ## 💡 Common Use Cases
159
-
160
- ### File System Operations
161
-
162
- ```bash
163
- # Install filesystem server
164
- /mcp install @modelcontextprotocol/server-filesystem
165
-
166
- # Configure
167
- /mcp config filesystem --path /workspace
168
-
169
- # Use in chat
170
- "List all TypeScript files in src/"
171
- ```
172
-
173
- ### GitHub Integration
174
-
175
- ```bash
176
- # Install GitHub server
177
- /mcp install @modelcontextprotocol/server-github
178
-
179
- # Authenticate
180
- /mcp oauth login github
181
-
182
- # Use in chat
183
- "Create a new issue in my repo"
184
- "List recent pull requests"
185
- ```
186
-
187
- ### Database Queries
188
-
189
- ```bash
190
- # Install database server
191
- /mcp install @modelcontextprotocol/server-postgres
192
-
193
- # Configure
194
- /mcp config postgres --connection-string $DATABASE_URL
195
-
196
- # Use in chat
197
- "Query users table"
198
- "Show database schema"
199
- ```
200
-
201
- **Learn more:** [Getting Started](MCP_GettingStarted.md#examples)
202
-
203
- ---
204
-
205
- ## 🛠️ Configuration
206
-
207
- ### MCP Server Configuration
208
-
209
- ```json
210
- {
211
- "mcpServers": {
212
- "filesystem": {
213
- "command": "npx",
214
- "args": ["-y", "@modelcontextprotocol/server-filesystem", "/workspace"],
215
- "env": {}
216
- },
217
- "github": {
218
- "command": "npx",
219
- "args": ["-y", "@modelcontextprotocol/server-github"],
220
- "env": {
221
- "GITHUB_TOKEN": "${GITHUB_TOKEN}"
222
- }
223
- }
224
- }
225
- }
226
- ```
227
-
228
- ### OAuth Configuration
229
-
230
- ```json
231
- {
232
- "oauth": {
233
- "github": {
234
- "clientId": "your-client-id",
235
- "clientSecret": "${GITHUB_CLIENT_SECRET}",
236
- "scopes": ["repo", "user"]
237
- }
238
- }
239
- }
240
- ```
241
-
242
- **Learn more:** [Integration](MCP_Integration.md#configuration)
243
-
244
- ---
245
-
246
- ## 🔍 Troubleshooting
247
-
248
- ### Common Issues
249
-
250
- **MCP server not starting:**
251
-
252
- - Check server installed: `/mcp list`
253
- - Verify command path
254
- - Check environment variables
255
- - View logs: `/mcp logs <server>`
256
-
257
- **Tools not available:**
258
-
259
- - Check server running: `/mcp status`
260
- - Restart server: `/mcp restart <server>`
261
- - Check tool registration: `/tools list`
262
-
263
- **OAuth authentication fails:**
264
-
265
- - Check OAuth configured: `/mcp oauth status`
266
- - Re-authenticate: `/mcp oauth login <provider>`
267
- - Check token expiry: `/mcp oauth status <provider>`
268
-
269
- **Server crashes:**
270
-
271
- - Check logs: `/mcp logs <server>`
272
- - Verify dependencies installed
273
- - Check server version compatibility
274
- - Report issue to server maintainer
275
-
276
- **See:** [Troubleshooting Guide](../Troubleshooting.md)
277
-
278
- ---
279
-
280
- ## 📊 Implementation Status
281
-
282
- ### Current (v0.1.0)
283
-
284
- - ✅ MCP Client Implementation
285
- - ✅ stdio Transport
286
- - ✅ Tool Discovery and Registration
287
- - ✅ Tool Execution
288
- - ✅ OAuth Integration (basic)
289
- - ✅ Server Management Commands
290
- - ✅ Health Monitoring
291
-
292
- ### Planned (v0.2.0)
293
-
294
- - ⏳ SSE Transport
295
- - ⏳ HTTP Transport
296
- - ⏳ Resource Support
297
- - ⏳ Prompt Template Support
298
- - ⏳ Advanced OAuth Features
299
-
300
- ### Planned (v0.3.0)
301
-
302
- - ⏳ MCP Marketplace UI
303
- - ⏳ Server Analytics
304
- - ⏳ Performance Monitoring
305
-
306
- ---
307
-
308
- ## 🤝 Related Documentation
309
-
310
- ### Core Systems
311
-
312
- - [Tools System](../Tools/README.md) - Tool execution
313
- - [Hooks System](../Hooks/README.md) - Event automation
314
- - [User Interface](../UI&Settings/README.md) - UI documentation
315
-
316
- ### Commands
317
-
318
- - [MCP Commands](MCP_Commands.md) - All MCP commands
319
- - [OAuth Commands](MCP_Commands.md#oauth-commands) - OAuth management
320
-
321
- ### Developer Resources
322
-
323
- - Knowledge DB: `dev_MCPIntegration.md` - MCP architecture
324
- - MCP Specification: https://modelcontextprotocol.io
325
-
326
- ---
327
-
328
- ## 🎯 Quick Start
329
-
330
- ### For New Users
331
-
332
- 1. **List Available Servers**
333
-
334
- ```bash
335
- /mcp marketplace
336
- ```
337
-
338
- 2. **Install Your First Server**
339
-
340
- ```bash
341
- /mcp install @modelcontextprotocol/server-filesystem
342
- ```
343
-
344
- 3. **Start Using Tools**
345
- ```
346
- "List files in the current directory"
347
- ```
348
-
349
- ### For Advanced Users
350
-
351
- 1. **Configure Custom Server**
352
-
353
- ```bash
354
- /mcp add my-server --command node --args server.js
355
- ```
356
-
357
- 2. **Set Up OAuth**
358
-
359
- ```bash
360
- /mcp oauth login github
361
- ```
362
-
363
- 3. **Monitor Server Health**
364
- ```bash
365
- /mcp health check
366
- ```
367
-
368
- ---
369
-
370
- ## 📈 Best Practices
371
-
372
- ### Server Management
373
-
374
- 1. **Start Small** - Install one server at a time
375
- 2. **Test Thoroughly** - Verify tools work before relying on them
376
- 3. **Monitor Health** - Check server status regularly
377
- 4. **Update Regularly** - Keep servers up to date
378
- 5. **Review Logs** - Check logs for errors
379
-
380
- ### Security
381
-
382
- 1. **Review Servers** - Only install trusted servers
383
- 2. **Limit Permissions** - Grant minimal necessary permissions
384
- 3. **Secure Tokens** - Use environment variables for secrets
385
- 4. **Regular Audits** - Review installed servers periodically
386
- 5. **OAuth Best Practices** - Use OAuth when available
387
-
388
- ### Performance
389
-
390
- 1. **Lazy Loading** - Only start servers when needed
391
- 2. **Resource Limits** - Set appropriate resource limits
392
- 3. **Cache Results** - Cache expensive operations
393
- 4. **Monitor Usage** - Track server resource usage
394
-
395
- ---
396
-
397
- ## 🌐 External Resources
398
-
399
- ### Official MCP Resources
400
-
401
- - **MCP Specification:** https://modelcontextprotocol.io
402
- - **MCP SDK:** https://github.com/modelcontextprotocol/sdk
403
- - **Official Servers:** https://github.com/modelcontextprotocol/servers
404
-
405
- ### Community
406
-
407
- - **Discord:** Join MCP community
408
- - **GitHub Discussions:** Ask questions
409
- - **Server Registry:** Browse community servers
410
-
411
- ---
412
-
413
- **Last Updated:** January 26, 2026
414
- **Version:** 0.1.0
415
- **Status:** Active Development