@rynko/mcp-server 1.0.3 → 1.0.4

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 (2) hide show
  1. package/README.md +25 -4
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -10,7 +10,7 @@ Rynko MCP server for Claude Desktop - manage templates and generate documents th
10
10
 
11
11
  Or install from the `.mcpb` bundle:
12
12
 
13
- 1. Download `rynko-mcp-{version}.mcpb` from the [releases page](https://github.com/rynko/rynko/releases)
13
+ 1. Download `rynko-mcp-{version}.mcpb` from the [releases page](https://github.com/rynko-dev/mcp-server/releases)
14
14
  2. In Claude Desktop, go to **Settings** → **Extensions**
15
15
  3. Click **Install from file** and select the downloaded `.mcpb` file
16
16
  4. Enter your Personal Access Token when prompted
@@ -98,10 +98,25 @@ Close and reopen Claude Desktop. You should see "rynko" in your available MCP se
98
98
 
99
99
  | Tool | Description |
100
100
  |------|-------------|
101
- | `preview_template` | Generate a preview document |
102
- | `generate_document` | Generate a production document |
101
+ | `preview_template` | Generate a preview document (free, no credits used) |
102
+ | `generate_document` | Generate a production document (uses credits) |
103
103
  | `get_job_status` | Check document generation status |
104
104
 
105
+ #### generate_document Parameters
106
+
107
+ | Parameter | Required | Description |
108
+ |-----------|----------|-------------|
109
+ | `workspace_id` | Yes | The workspace ID |
110
+ | `template_id` | Yes | The template ID to generate from |
111
+ | `variables` | Yes | Variable values for the document |
112
+ | `format` | No | Output format: `pdf` (default) or `excel` |
113
+ | `filename` | No | Custom filename (without extension) |
114
+ | `use_draft` | No | Use draft version instead of published (default: false) |
115
+ | `use_credits` | No | Use premium credits to generate without watermark (default: false) |
116
+ | `metadata` | No | Custom key-value metadata for the document job |
117
+
118
+ **Note on Watermarks:** Free tier documents include a watermark. Set `use_credits: true` to generate watermark-free documents using your purchased premium credits.
119
+
105
120
  ## Example Usage
106
121
 
107
122
  Once configured, you can have natural conversations with Claude:
@@ -118,6 +133,12 @@ Once configured, you can have natural conversations with Claude:
118
133
  >
119
134
  > *[Generates PDF using your template]*
120
135
 
136
+ > **You:** Generate a professional invoice without watermark for my client presentation.
137
+ >
138
+ > **Claude:** I'll generate a watermark-free invoice using your premium credits...
139
+ >
140
+ > *[Generates PDF with use_credits: true]*
141
+
121
142
  ## Environment Variables
122
143
 
123
144
  | Variable | Required | Description |
@@ -161,7 +182,7 @@ Once configured, you can have natural conversations with Claude:
161
182
  ## Support
162
183
 
163
184
  - **Email**: support@rynko.dev
164
- - **Issues**: [GitHub Issues](https://github.com/rynko/rynko/issues)
185
+ - **Issues**: [GitHub Issues](https://github.com/rynko-dev/mcp-server/issues)
165
186
 
166
187
  ## Building from Source
167
188
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@rynko/mcp-server",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "Rynko MCP server for Claude Desktop - manage templates and generate documents through natural conversation",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
7
- "rynko-mcp": "./dist/index.js"
7
+ "rynko-mcp": "dist/index.js"
8
8
  },
9
9
  "types": "dist/index.d.ts",
10
10
  "files": [