@cronicorn/mcp-server 1.5.1 → 1.5.3
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.
- package/dist/docs/introduction.md +3 -0
- package/package.json +1 -1
- package/dist/docs/README.md +0 -133
package/package.json
CHANGED
package/dist/docs/README.md
DELETED
|
@@ -1,133 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
id: docs-readme
|
|
3
|
-
title: Cronicorn Documentation
|
|
4
|
-
description: Documentation overview and navigation guide
|
|
5
|
-
tags:
|
|
6
|
-
- user
|
|
7
|
-
- assistant
|
|
8
|
-
- essential
|
|
9
|
-
sidebar_position: 10
|
|
10
|
-
mcp:
|
|
11
|
-
uri: file:///docs/README.md
|
|
12
|
-
mimeType: text/markdown
|
|
13
|
-
priority: 1.0
|
|
14
|
-
lastModified: 2025-11-02T00:00:00Z
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
# Cronicorn Documentation
|
|
18
|
-
|
|
19
|
-
Welcome to the Cronicorn documentation! This guide will help you find the right documentation for your needs.
|
|
20
|
-
|
|
21
|
-
## Quick Navigation
|
|
22
|
-
|
|
23
|
-
### 🚀 Getting Started (SaaS Users)
|
|
24
|
-
|
|
25
|
-
Using Cronicorn as a hosted service? Start here:
|
|
26
|
-
|
|
27
|
-
1. **[Introduction](./introduction.md)** - What is Cronicorn and why use it
|
|
28
|
-
2. **[Quick Start](./quick-start.md)** - Create your first scheduled job in 5 minutes
|
|
29
|
-
3. **[Core Concepts](./core-concepts.md)** - Understand jobs, endpoints, and AI scheduling
|
|
30
|
-
|
|
31
|
-
**Perfect for:**
|
|
32
|
-
- SaaS developers monitoring APIs
|
|
33
|
-
- Teams running scheduled tasks
|
|
34
|
-
- Anyone using Cronicorn as a service
|
|
35
|
-
|
|
36
|
-
### 🔧 Self-Hosting (Developers)
|
|
37
|
-
|
|
38
|
-
Want to deploy Cronicorn yourself? See technical docs:
|
|
39
|
-
|
|
40
|
-
1. **[System Architecture](./technical/system-architecture.md)** - How Cronicorn works internally
|
|
41
|
-
2. **[How Scheduling Works](./technical/how-scheduling-works.md)** - The governor algorithm
|
|
42
|
-
3. **[How AI Adaptation Works](./technical/how-ai-adaptation-works.md)** - Optional AI features
|
|
43
|
-
4. **[Configuration & Constraints](./technical/configuration-and-constraints.md)** - Safety and limits
|
|
44
|
-
|
|
45
|
-
**Perfect for:**
|
|
46
|
-
- DevOps engineers deploying Cronicorn
|
|
47
|
-
- Contributors to the open-source project
|
|
48
|
-
- Advanced users customizing the system
|
|
49
|
-
|
|
50
|
-
### 🤖 AI Assistant Integration
|
|
51
|
-
|
|
52
|
-
Using Cronicorn with Claude, Cursor, or other AI assistants?
|
|
53
|
-
|
|
54
|
-
- **[MCP Server](https://www.npmjs.com/package/@cronicorn/mcp-server)** - Model Context Protocol integration
|
|
55
|
-
- Install with: `npm install -g @cronicorn/mcp-server`
|
|
56
|
-
- See [Quick Start MCP Section](./quick-start.md#using-with-ai-assistants) for setup
|
|
57
|
-
|
|
58
|
-
**Perfect for:**
|
|
59
|
-
- Claude Desktop users
|
|
60
|
-
- VS Code with GitHub Copilot
|
|
61
|
-
- Cursor, Cline, Continue users
|
|
62
|
-
|
|
63
|
-
## Documentation Tags
|
|
64
|
-
|
|
65
|
-
Documents are tagged for different audiences:
|
|
66
|
-
|
|
67
|
-
- **`user`** - End users of the Cronicorn service
|
|
68
|
-
- **`assistant`** - AI assistants accessing via MCP
|
|
69
|
-
- **`essential`** - Core documentation everyone should read
|
|
70
|
-
|
|
71
|
-
## Available Documentation
|
|
72
|
-
|
|
73
|
-
### User Documentation
|
|
74
|
-
- ✅ [Introduction](./introduction.md) - Overview and key features
|
|
75
|
-
- ✅ [Core Concepts](./core-concepts.md) - Jobs, endpoints, scheduling, AI hints
|
|
76
|
-
- ✅ [Quick Start](./quick-start.md) - Get started in 5 minutes
|
|
77
|
-
|
|
78
|
-
### Technical Documentation (Self-Hosting)
|
|
79
|
-
- ✅ [System Architecture](./technical/system-architecture.md) - Hexagonal architecture overview
|
|
80
|
-
- ✅ [How Scheduling Works](./technical/how-scheduling-works.md) - Governor algorithm details
|
|
81
|
-
- ✅ [How AI Adaptation Works](./technical/how-ai-adaptation-works.md) - AI planner internals
|
|
82
|
-
- ✅ [Coordinating Multiple Endpoints](./technical/coordinating-multiple-endpoints.md) - Advanced patterns
|
|
83
|
-
- ✅ [Configuration & Constraints](./technical/configuration-and-constraints.md) - Safety mechanisms
|
|
84
|
-
- ✅ [Technical Reference](./technical/reference.md) - API contracts and database schema
|
|
85
|
-
|
|
86
|
-
## About This Documentation
|
|
87
|
-
|
|
88
|
-
This directory (`docs-v2/`) serves as the **single source of truth** for Cronicorn documentation, consumed by:
|
|
89
|
-
|
|
90
|
-
- **Docusaurus website** - Human-readable documentation site
|
|
91
|
-
- **MCP server** - AI assistants accessing documentation via Model Context Protocol
|
|
92
|
-
|
|
93
|
-
### Frontmatter Structure
|
|
94
|
-
|
|
95
|
-
Each document includes metadata for both humans and AI:
|
|
96
|
-
|
|
97
|
-
```yaml
|
|
98
|
-
---
|
|
99
|
-
id: unique-identifier
|
|
100
|
-
title: Human-Readable Title
|
|
101
|
-
description: Brief description
|
|
102
|
-
tags:
|
|
103
|
-
- user # For end users
|
|
104
|
-
- assistant # For AI assistants
|
|
105
|
-
- essential # Core documentation
|
|
106
|
-
sidebar_position: 1
|
|
107
|
-
mcp:
|
|
108
|
-
uri: file:///docs/filename.md
|
|
109
|
-
mimeType: text/markdown
|
|
110
|
-
priority: 0.9 # 0.0-1.0, higher = more important
|
|
111
|
-
lastModified: 2025-11-02T00:00:00Z
|
|
112
|
-
---
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
## Contributing
|
|
116
|
-
|
|
117
|
-
Found an issue or want to improve the docs?
|
|
118
|
-
|
|
119
|
-
1. **Report issues**: [GitHub Issues](https://github.com/weskerllc/cronicorn/issues)
|
|
120
|
-
2. **Suggest improvements**: [GitHub Discussions](https://github.com/weskerllc/cronicorn/discussions)
|
|
121
|
-
3. **Submit PRs**: See our contributing guidelines on GitHub
|
|
122
|
-
|
|
123
|
-
## Getting Help
|
|
124
|
-
|
|
125
|
-
- 📖 [Documentation Site](https://cronicorn.com/docs)
|
|
126
|
-
- 💬 [Discord Community](https://discord.gg/cronicorn)
|
|
127
|
-
- 📧 [Email Support](mailto:support@cronicorn.com)
|
|
128
|
-
|
|
129
|
-
## Related Resources
|
|
130
|
-
|
|
131
|
-
- **[MCP Server Package](https://www.npmjs.com/package/@cronicorn/mcp-server)** - AI assistant integration
|
|
132
|
-
- **[GitHub Repository](https://github.com/weskerllc/cronicorn)** - Source code and issues
|
|
133
|
-
- **[API Documentation](https://app.cronicorn.com/docs/api)** - REST API reference
|