@rynko/mcp-server 1.0.7 → 1.0.9
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/LICENSE +21 -0
- package/README.md +107 -19
- package/dist/index.js +1 -1
- package/package.json +4 -2
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024-2026 Rynko
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -119,25 +119,91 @@ Close and reopen Claude Desktop. You should see "rynko" in your available MCP se
|
|
|
119
119
|
|
|
120
120
|
## Example Usage
|
|
121
121
|
|
|
122
|
-
Once configured, you can have natural conversations with Claude:
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
>
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
122
|
+
Once configured, you can have natural conversations with Claude. Here are detailed examples of how to use each tool:
|
|
123
|
+
|
|
124
|
+
### Example 1: List Templates and Generate a Document
|
|
125
|
+
|
|
126
|
+
**User Prompt:**
|
|
127
|
+
> "Show me all the templates in my workspace and generate an invoice for Acme Corp"
|
|
128
|
+
|
|
129
|
+
**Expected Behavior:**
|
|
130
|
+
1. Claude calls `list_workspaces` to find your workspaces
|
|
131
|
+
2. Claude calls `list_templates` with your workspace ID
|
|
132
|
+
3. Claude displays available templates
|
|
133
|
+
4. Claude calls `get_template` to get the invoice template's variable schema
|
|
134
|
+
5. Claude calls `generate_document` with the template ID and variables:
|
|
135
|
+
```json
|
|
136
|
+
{
|
|
137
|
+
"workspace_id": "ws_xxx",
|
|
138
|
+
"template_id": "invoice-template",
|
|
139
|
+
"variables": {
|
|
140
|
+
"customerName": "Acme Corp",
|
|
141
|
+
"invoiceNumber": "INV-2024-001",
|
|
142
|
+
"items": [{"name": "Consulting", "quantity": 10, "price": 150}],
|
|
143
|
+
"total": 1500
|
|
144
|
+
},
|
|
145
|
+
"format": "pdf"
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
6. Claude returns the download URL for the generated PDF
|
|
149
|
+
|
|
150
|
+
### Example 2: Preview Before Generating (Free)
|
|
151
|
+
|
|
152
|
+
**User Prompt:**
|
|
153
|
+
> "I want to test my new report template before using credits. Preview it with sample data."
|
|
154
|
+
|
|
155
|
+
**Expected Behavior:**
|
|
156
|
+
1. Claude calls `list_templates` to find the report template
|
|
157
|
+
2. Claude calls `get_template` to understand required variables
|
|
158
|
+
3. Claude calls `preview_template` with sample data:
|
|
159
|
+
```json
|
|
160
|
+
{
|
|
161
|
+
"workspace_id": "ws_xxx",
|
|
162
|
+
"template_id": "monthly-report",
|
|
163
|
+
"variables": {
|
|
164
|
+
"reportTitle": "Q4 Sales Report",
|
|
165
|
+
"reportDate": "2024-12-31",
|
|
166
|
+
"metrics": [{"name": "Revenue", "value": "$125,000"}]
|
|
167
|
+
},
|
|
168
|
+
"format": "pdf",
|
|
169
|
+
"version": "draft"
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
4. Claude provides a preview URL (valid for 5 minutes, no credits used)
|
|
173
|
+
5. User reviews the preview and confirms it looks correct
|
|
174
|
+
|
|
175
|
+
### Example 3: Create a New Template from Scratch
|
|
176
|
+
|
|
177
|
+
**User Prompt:**
|
|
178
|
+
> "Create a professional certificate template with recipient name, course title, completion date, and a signature line"
|
|
179
|
+
|
|
180
|
+
**Expected Behavior:**
|
|
181
|
+
1. Claude calls `get_schema_reference` to understand the template schema format
|
|
182
|
+
2. Claude calls `list_workspaces` to find where to create the template
|
|
183
|
+
3. Claude calls `create_draft_template` with the full schema:
|
|
184
|
+
```json
|
|
185
|
+
{
|
|
186
|
+
"workspace_id": "ws_xxx",
|
|
187
|
+
"name": "Course Certificate",
|
|
188
|
+
"description": "Professional certificate for course completion",
|
|
189
|
+
"format": "pdf",
|
|
190
|
+
"schema": {
|
|
191
|
+
"pages": [{
|
|
192
|
+
"id": "page-1",
|
|
193
|
+
"components": [
|
|
194
|
+
{"id": "title", "type": "heading", "props": {"level": 1, "text": "Certificate of Completion"}},
|
|
195
|
+
{"id": "recipient", "type": "rich-text", "props": {}, "content": "This certifies that <strong>{{recipientName}}</strong>..."}
|
|
196
|
+
]
|
|
197
|
+
}]
|
|
198
|
+
},
|
|
199
|
+
"variables": [
|
|
200
|
+
{"name": "recipientName", "type": "string", "label": "Recipient Name"},
|
|
201
|
+
{"name": "courseTitle", "type": "string", "label": "Course Title"},
|
|
202
|
+
{"name": "completionDate", "type": "date", "label": "Completion Date"}
|
|
203
|
+
]
|
|
204
|
+
}
|
|
205
|
+
```
|
|
206
|
+
4. Claude confirms the draft was created and provides a link to the visual designer for final adjustments
|
|
141
207
|
|
|
142
208
|
## Environment Variables
|
|
143
209
|
|
|
@@ -225,6 +291,28 @@ To submit to the Claude Desktop Extensions directory:
|
|
|
225
291
|
- 3+ usage examples
|
|
226
292
|
- Safety annotations (data access, network access)
|
|
227
293
|
|
|
294
|
+
## Privacy Policy
|
|
295
|
+
|
|
296
|
+
This extension connects to Rynko's API to manage templates and generate documents. By using this extension, you agree to Rynko's Privacy Policy.
|
|
297
|
+
|
|
298
|
+
**Data Collection & Usage:**
|
|
299
|
+
- **Authentication**: Your Personal Access Token is stored securely using the operating system's credential manager (Keychain on macOS, Credential Manager on Windows)
|
|
300
|
+
- **Template Data**: Template schemas and variables are transmitted to Rynko's servers for document generation
|
|
301
|
+
- **Document Variables**: Data you provide for document generation is processed on Rynko's servers to render documents
|
|
302
|
+
- **Generated Documents**: Documents are stored temporarily (configurable retention period) and accessible via secure, time-limited URLs
|
|
303
|
+
|
|
304
|
+
**Data Sharing:**
|
|
305
|
+
- We do not sell or share your data with third parties
|
|
306
|
+
- Data is processed solely for the purpose of generating your documents
|
|
307
|
+
|
|
308
|
+
**Data Retention:**
|
|
309
|
+
- Generated documents are retained based on your subscription tier's retention policy
|
|
310
|
+
- You can delete documents at any time from your Rynko dashboard
|
|
311
|
+
|
|
312
|
+
**Full Privacy Policy:** [https://www.rynko.dev/privacy](https://www.rynko.dev/privacy)
|
|
313
|
+
|
|
314
|
+
**Contact:** For privacy-related inquiries, contact privacy@rynko.dev
|
|
315
|
+
|
|
228
316
|
## License
|
|
229
317
|
|
|
230
318
|
MIT
|
package/dist/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rynko/mcp-server",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.9",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Rynko MCP server for Claude Desktop - manage templates and generate documents through natural conversation",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -16,9 +16,10 @@
|
|
|
16
16
|
"build": "tsc",
|
|
17
17
|
"dev": "tsc --watch",
|
|
18
18
|
"start": "node dist/index.js",
|
|
19
|
+
"bundle": "node scripts/bundle.mjs",
|
|
19
20
|
"prepublishOnly": "npm run build",
|
|
20
21
|
"lint": "eslint src --ext .ts",
|
|
21
|
-
"clean": "rimraf dist",
|
|
22
|
+
"clean": "rimraf dist dist-bundle",
|
|
22
23
|
"build:mcpb": "bash scripts/build-mcpb.sh"
|
|
23
24
|
},
|
|
24
25
|
"keywords": [
|
|
@@ -49,6 +50,7 @@
|
|
|
49
50
|
},
|
|
50
51
|
"devDependencies": {
|
|
51
52
|
"@types/node": "^20.10.0",
|
|
53
|
+
"esbuild": "^0.20.0",
|
|
52
54
|
"rimraf": "^5.0.5",
|
|
53
55
|
"typescript": "^5.3.0"
|
|
54
56
|
}
|