
relaydigital/vremly-mcp
Developer toolsЭта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал
Model Context Protocol server for the Vremly API — install with npx -y github:RelayDigital/vremly-mcp
Обзор
Gives an AI assistant access to the Vremly API over the Model Context Protocol — so it can look up your shoots, customers, media and invoices, and change them if you let it. Create an API key in the Vremly app under , then add this to your MCP host's config: For , that goes in .mcp.json in your project, or run: There is nothing to clone or build — npx fetches the repo and compiles it on first run. VREMLY_MCP_READ_ONLY=1 also permits these reviewed POST operations, which need a request body to calculate a preview: - /orders/prepare - /agent-actions/booking/preview - /agent-actions/rebook/{projectId}/preview - /agent-actions/delivery/{projectId}/preview - /agent-actions/followup/{projectId}/preview - /agent-migrations/{migrationId}/reconciliation-preview - /agent-actions/{booking|delivery|followup}/receipts/{receiptId}/reconciliation-preview Other POST operations and all PUT/PATCH/DELETE operations are refused in this mode.
README
Показан фрагмент оригинального README. Открыть оригинал.
Vremly MCP server
Gives an AI assistant access to the Vremly API over the Model Context Protocol — so it can look up your shoots, customers, media and invoices, and change them if you let it.
Full documentation: docs.vremly.com/guides/mcp
Install
Create an API key in the Vremly app under Settings → API Keys, then add this to your MCP host’s config:
{
"mcpServers": {
"vremly": {
"command": "npx",
"args": ["-y", "github:RelayDigital/vremly-mcp"],
"env": {
"VREMLY_API_KEY": "your-api-key"
}
}
}
}
For Claude Code, that goes in .mcp.json in your project, or run:
claude mcp add vremly --env VREMLY_API_KEY=your-api-key \
-- npx -y github:RelayDigital/vremly-mcp
There is nothing to clone or build — npx fetches the repo and compiles it on
first run.
Configuration
| Variable | Default | Purpose |
|---|---|---|
VREMLY_API_KEY |
(required) | Your organization API key. |
VREMLY_API_URL |
https://api.vremly.com |
API base URL. |
VREMLY_MCP_READ_ONLY |
unset | 1 permits GET/HEAD/OPTIONS and explicitly reviewed preparation/preview POST operations only. |
VREMLY_MCP_TIMEOUT_MS |
30000 |
Per-request timeout. |
VREMLY_OPENAPI_PATH |
bundled | Point at a different OpenAPI document. |
Read-only sessions
VREMLY_MCP_READ_ONLY=1 also permits these reviewed POST operations, which need a request body to calculate a preview:
/orders/prepare/agent-actions/booking/preview/agent-actions/rebook/{projectId}/preview/agent-actions/delivery/{projectId}/preview/agent-actions/followup/{projectId}/preview/agent-migrations/{migrationId}/reconciliation-preview/agent-actions/{booking|delivery|followup}/receipts/{receiptId}/reconciliation-preview
Other POST operations and all PUT/PATCH/DELETE operations are refused in this mode. These previews do not confirm bookings, charge payments, deliver media, send follow-up or commit migration changes. API-key scopes and organization/project authorization still apply to every permitted request.
Tools
Four tools expose the reviewed public integration surface:
| Tool | Purpose |
|---|---|
vremly_capabilities |
Inspect the connected organization and granted business permissions. |
vremly_search_endpoints |
Find endpoints by keyword. |
vremly_describe_endpoint |
Parameters, required body fields, responses and permissions. |
vremly_request |
Call an endpoint and return its status and body. |
Use capabilities → search → describe → request. Describing before calling avoids guessing request fields. Validated request bodies reject unknown fields with HTTP 400; endpoints without a published body schema may ignore unknown fields. The endpoint description identifies which behavior applies.
Permissions
Установка
npx -y github:RelayDigital/vremly-mcpКонфигурация
{
"mcpServers": {
"vremly": {
"command": "npx",
"args": ["-y", "github:RelayDigital/vremly-mcp"],
"env": {
"VREMLY_API_KEY": "your-api-key"
}
}
}
}