relaydigital/vremly-mcp

开发工具

本页由 AI 翻译，技术细节请以原文为准。查看原文

0 stars 0 forks 质量 68 趋势 14

Repository Install

Vremly API 的 Model Context 协议服务器 — 用 npx -y 安装 github：RelayDigital/vremly-mcp

概览

它让AI助手通过Model Context Protocol访问Vremly API——这样它可以查询你的拍摄、客户、媒体和发票，并在你允许的情况下更改它们。在Vremly应用中创建一个API密钥，然后添加到你的MCP主机配置中：对于，该函数.mcp.json在你的项目中，或者运行：没有什么可以克隆或构建的——npx会在第一次运行时获取仓库并编译。 VREMLY_MCP_READ_ONLY=1 还允许这些被审查的 POST 操作，需要请求体来计算预览： - /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 其他POST操作以及所有PUT/PATCH/DELETE操作在此模式下都被拒绝。

概述（AI 翻译）

让 AI 助手能够通过模型上下文协议——以便查找你的拍摄、客户、媒体和发票，如果你愿意，也可以更改它们。

完整文档：docs.vremly.com/guides/mcp

安装

在Vremly应用的设置→API密钥下创建一个API密钥，然后添加这是你MCP主机配置的配置：

对于Claude代码，可以放在你的项目中的.mcp.json，或者运行：

没有什么可以克隆或构建的——npx取回仓库并编译它第一次跑。

配置

变量	默认	目的
`VREMLY_API_KEY`	（必需）	您的组织API密钥。
`VREMLY_API_URL`	`https://api.vremly.com`	API 基础 URL。
`VREMLY_MCP_READ_ONLY`	未设置	`1` 仅允许 GET/HEAD/OPTIONS 以及明确复习的准备/预览 POST 操作。
`VREMLY_MCP_TIMEOUT_MS`	`30000`	按请求超时。
`VREMLY_OPENAPI_PATH`	捆绑	指向另一个OpenAPI文档。

只读会话

VREMLY_MCP_READ_ONLY=1 还允许这些被审查的 POST 操作，需要请求机构来计算预览：

/orders/prepare
/agent-actions/booking/preview

本页由 AI 翻译，技术细节请以原文为准。

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

在 GitHub 查看完整 README

安装

npx -y github:RelayDigital/vremly-mcp

新手？先看 mcpskill.org 教程 →

配置

{
  "mcpServers": {
    "vremly": {
      "command": "npx",
      "args": ["-y", "github:RelayDigital/vremly-mcp"],
      "env": {
        "VREMLY_API_KEY": "your-api-key"
      }
    }
  }
}