Skip to main content

MCP Integration

Connect your AI assistant to Rynko using the Model Context Protocol (MCP). Manage templates and generate documents through natural conversation.

Supported AI Tools​

ToolConfig FileTop-Level Key
Claude Desktopclaude_desktop_config.jsonmcpServers
Cursor.cursor/mcp.jsonmcpServers
Windsurf~/.codeium/windsurf/mcp_config.jsonmcpServers
VS Code.vscode/mcp.jsonservers (with "type": "stdio")
Zed~/.config/zed/settings.jsoncontext_servers

Features​

  • Natural Language Templates - Describe what you need and let AI create templates
  • Cross-Environment Access - Work across all your environments with a single token
  • Draft-Only Safety - Templates created via MCP are drafts until you publish them
  • Document Generation - Preview and generate documents directly from chat
  • Data Import - Parse Excel/CSV files and auto-map columns to template variables
  • Audit Trail - All MCP operations are logged for security and compliance

Quick Start​

Step 1: Generate a Personal Access Token​

  1. Log in to your Rynko Dashboard
  2. Go to Settings → Personal Access Tokens
  3. Click Create Token
  4. Enter a label (e.g., "Claude Desktop" or "Cursor")
  5. Select expiry (max 30 days)
  6. Click Create and copy the token immediately - it won't be shown again
warning

Keep your PAT secure. Anyone with this token can access your templates across all environments.

Step 2: Configure Your AI Tool​

  1. Open Claude Desktop → Settings → Extensions
  2. Search for "Rynko" and click Install
  3. Enter your Personal Access Token when prompted
  4. Done! Start chatting about your documents.

Manual Configuration (Alternative)​

Add to your Claude Desktop config file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

Windows: %APPDATA%\Claude\claude_desktop_config.json

Linux: ~/.config/Claude/claude_desktop_config.json

You can also open it from Claude Desktop via Settings > Developer > Edit Config.

{
  "mcpServers": {
    "rynko": {
      "command": "npx",
      "args": ["-y", "@rynko/mcp-server"],
      "env": {
        "RYNKO_USER_TOKEN": "pat_xxxxxxxxxxxxxxxx"
      }
    }
  }
}

Replace pat_xxxxxxxxxxxxxxxx with your actual PAT, then restart Claude Desktop.

Step 3: Verify Connection​

After restarting your AI tool, you should see "Rynko" in your available MCP servers/tools. Try asking:

  • "List my templates"
  • "What environments do I have access to?"

Available Tools​

Once connected, your AI assistant has access to these Rynko tools:

Environment Tools​

ToolDescription
list_environmentsList all environments you have access to
get_environmentGet details of a specific environment

Template Tools​

ToolDescription
list_templatesList templates in an environment
get_templateGet template details and schema
create_draft_templateCreate a new draft template
update_draft_templateUpdate a draft template
validate_schemaValidate template schema before creating
get_schema_referenceGet the template schema documentation

Data Tools​

ToolDescription
parse_data_fileParse Excel or CSV data to JSON
map_variablesAuto-map data columns to template variables

Generation Tools​

ToolDescription
preview_templateGenerate a preview document
generate_documentGenerate a production document
get_job_statusCheck document generation status

Asset Tools​

ToolDescription
list_assetsList uploaded assets in an environment
upload_assetUpload an image or file for use in templates

Integration Tools​

ToolDescription
get_sdk_examplesGet SDK code examples for Node.js, Python, Java, or REST API integration
tip

Ask your AI assistant "How do I generate PDFs from my Node.js app?" or "Show me Python code to integrate Rynko" — it will call get_sdk_examples to return working code with install instructions.

Example Conversations​

Creating a New Template​

You: Create an invoice template for my consulting business with company logo, client details, line items table, and payment terms.

AI: I'll create an invoice template for you. First, let me check your environments...

[AI uses list_environments, then create_draft_template]

I've created a draft invoice template in your "Production" environment. It includes:

  • Header with logo placeholder and company name
  • Client details section
  • Line items table with quantity, description, rate, and amount
  • Subtotal, tax, and total calculations
  • Payment terms footer

Would you like me to generate a preview so you can see how it looks?

Generating Documents from Data​

You: I have a spreadsheet with customer data. Can you generate invoices for each customer?

AI: Of course! Please share the spreadsheet file.

[You attach customers.xlsx]

AI: [Uses parse_data_file] I found 15 customers in your spreadsheet with columns: Name, Email, Amount, Due Date.

Let me map these to your invoice template... [Uses map_variables]

The mapping looks good:

  • Name → customer.name (95% confidence)
  • Amount → invoice.total (90% confidence)
  • Due Date → invoice.dueDate (85% confidence)

Should I generate the invoices?

Editing Existing Templates​

You: Add a discount field to my invoice template

AI: [Uses get_template, then update_draft_template]

I've added a discount field to your invoice. Changes made:

  • Added discount variable (number, default: 0)
  • Added discount row between subtotal and total
  • Updated total calculation: subtotal - discount + tax

This is saved as a draft. Preview it in your dashboard before publishing.

Getting SDK Code Examples​

You: I need to add PDF invoice generation to my Node.js Express app. Show me how to integrate Rynko.

AI: [Uses get_sdk_examples with language: "nodejs"]

Here's how to integrate Rynko into your Express app:

npm install @rynko/sdk
import { Rynko } from '@rynko/sdk';

const rynko = new Rynko({ apiKey: process.env.RYNKO_API_KEY });

app.post('/invoices/:id/pdf', async (req, res) => {
  const result = await rynko.documents.generatePdf({
    templateId: 'your-invoice-template',
    variables: { invoiceNumber: req.params.id, ... },
  });
  res.json({ downloadUrl: result.downloadUrl });
});

Want me to show the Python or Java equivalent too?

Security & Permissions​

Token Security​

  • 30-Day Max Expiry: PATs expire automatically to limit exposure
  • SHA-256 Hashing: Tokens are stored as hashes, not plain text
  • IP Tracking: Last used IP is recorded for security monitoring
  • Revocable: Instantly revoke tokens from your dashboard

Draft-Only Operations​

Templates created or modified via MCP are always saved as drafts. This prevents AI from accidentally publishing breaking changes to production templates.

To publish a template:

  1. Log in to your Rynko dashboard
  2. Review the draft changes
  3. Click Publish to make it live

Audit Logging​

All MCP operations are logged in your project's activity feed:

  • Template created/updated
  • Documents generated
  • Data files parsed
  • Token used (with IP address)

View activity in Settings → Activity in your dashboard.

Tier Limits​

MCP operations use your existing Rynko quota:

FeatureFreeStarterGrowthScale
TemplatesUnlimitedUnlimitedUnlimitedUnlimited
Environments125Unlimited
Document Generation50/mo600/mo4,000/mo12,000/mo
PAT Creation1310Unlimited
info

Template previews do not consume your document quota.

Environment Variables​

VariableRequiredDescription
RYNKO_USER_TOKENYesYour Personal Access Token (starts with pat_)
RYNKO_API_URLNoCustom API URL (default: https://api.rynko.dev/api)

Troubleshooting​

"Invalid token" Error​

  • Verify the token starts with pat_
  • Check if the token has expired
  • Generate a new token from your dashboard

"Environment not found" Error​

  • Ensure you have access to the environment
  • Your role must be EDITOR or ADMIN to create/modify templates

AI Tool Not Connecting​

  1. Check your config file path and JSON syntax
  2. Ensure npx is available in your PATH
  3. Restart your AI tool completely
  4. Check the AI tool's logs for errors

Templates Not Appearing​

  • Templates must be in an environment you have access to
  • Check if you're looking at the right environment
  • Refresh by asking the AI to list templates again

NPM Package​

The MCP server is available as an npm package:

npm install -g @rynko/mcp-server

Or run directly with npx:

RYNKO_USER_TOKEN=pat_xxx npx @rynko/mcp-server

Package: @rynko/mcp-server

Source: GitHub

Privacy & Data​

  • Local Processing: AI tools run locally on your machine
  • API Calls: Only MCP tool calls go to Rynko servers
  • No Training: Your templates and data are not used for AI training
  • Data Retention: Documents follow your project's retention policy

Support​

Related: AI Toolkit | Personal Access Tokens | Templates