- Home
- MCP servers
- Orshot
Orshot
- javascript
3
GitHub Stars
javascript
Language
6 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Orshot MCP Server lets you dynamically generate images from your templates using prompts in Claude, Cursor, or any app that supports MCP Servers. This server runs locally or in your environment, exposing a standardized interface you can connect to from MCP clients to render images on demand.
How to use
You connect an MCP client to the Orshot MCP Server to generate images from Studio and Library templates. Start by obtaining an API key from Orshot and then configure your client to pass that key to the server. When you issue generation requests, you can rely on the server to select the appropriate template and render the image based on your prompt.
How to install
Prerequisites: Node.js and npm installed on your system.
- Install dependencies and build the project.
npm install
npm run build
- Configure your API key for Orshot. This example sets the variable in your shell session.
export ORSHOT_API_KEY="your-api-key-here"
- Run the production server.
npm start
Additional sections
MCP integration allows you to add Orshot as an MCP server in your client configuration. The following example shows how to integrate the server into Claude Desktop. You supply the node runtime, the path to the built MCP server, and your API key.
{
"mcpServers": {
"orshot": {
"command": "node", // or output of "which node"
"args": ["/path/to/orshot-mcp-server/build/index.js"], // update the path
"env": { "ORSHOT_API_KEY": "your-api-key" }
}
}
}
If you use a different shell or environment manager (for example, nvm or asdf), ensure the command resolves to the correct node binary by running "which node" and passing that path as the command value.
Examples you can try with Orshot MCP Server include generating a mockup from a studio template, capturing a website screenshot, or rendering a banner with a specific heading and subheading. You can also list templates and check API status as needed.
If you need help, check your API key and account status in the Orshot Dashboard, review the Orshot API documentation, and contact Orshot support at hi@orshot.com if issues persist.
Development and troubleshooting tips:
# Install dependencies
npm install
# Build for development or production
npm run build
# Run in development mode
npm run dev
Available tools
Get Library Templates
List all available library templates for your account, enabling you to see options you can generate from.
Get Studio Templates
List all studio templates available to you for creating complex, multi-step visuals.
Get Template Modifications
Fetch the available parameters or modifications you can apply to a given template.
Generate Image
Unified tool to generate images, PDFs, or videos with automatic template detection.
Generate Image From Library Template
Create visuals using a library template with your chosen assets.
Generate Image From Studio Template
Produce images, PDFs, or videos from a Studio template with customizable parameters.
Get Orshot Docs
Retrieve the latest Orshot documentation directly from the service.
List Docs Topics
List available documentation topics for quick navigation.
Check API Status
Test connectivity and validate your API key against the Orshot MCP service.