mcp-preflight

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

MCP Preflight

MCP预检

Read This Before Any ImageKit MCP Call

在调用任何ImageKit MCP工具前请阅读本文

You have access to two ImageKit MCP servers. Each serves a different purpose. Calling the wrong server or the wrong tool wastes tokens and produces errors. This skill is your routing table.
你可以访问两台ImageKit MCP服务器,每台服务器的用途不同。调用错误的服务器或工具会浪费令牌并产生错误。本技能就是你的路由表。

Server Map

服务器映射

imagekit_api
— Authenticated API Server

imagekit_api
— 已认证API服务器

Prefix:
mcp_imagekit_api_*
Two tools only:
ToolPurpose
search_doc
Local search that only searches TypeScript SDK code — use to find method signatures and types
execute
Executes TypeScript code against the ImageKit SDK to perform CRUD operations
All CRUD operations are performed by writing TypeScript code that runs via
execute
:
  • List, search, get details of files
  • Delete, move, copy, rename files
  • Create, delete, move, copy folders
  • Bulk tag/untag operations
  • File versions (list, restore, delete)
  • Custom metadata fields (CRUD)
  • Cache invalidation (purge)
  • URL endpoints and origins management
  • Account usage stats
前缀:
mcp_imagekit_api_*
仅包含两个工具:
工具用途
search_doc
仅搜索TypeScript SDK代码的本地搜索工具——用于查找方法签名和类型
execute
执行TypeScript代码调用ImageKit SDK以完成CRUD操作
所有CRUD操作都需通过编写TypeScript代码并借助
execute
执行:
  • 列出、搜索、获取文件详情
  • 删除、移动、复制、重命名文件
  • 创建、删除、移动、复制文件夹
  • 批量标记/取消标记操作
  • 文件版本(列出、恢复、删除)
  • 自定义元数据字段(CRUD)
  • 缓存失效(清除)
  • URL端点和源站管理
  • 账户使用统计

imagekit_devtools
— Public Tools Server

imagekit_devtools
— 公共工具服务器

Prefix:
mcp_imagekit_devtools_*
Two tools only — no auth required:
ToolPurpose
search_docs
RAG-powered search across ImageKit docs, guides, API refs, SDKs, community posts
transformation_builder
Builds transformation URLs from natural language descriptions
前缀:
mcp_imagekit_devtools_*
仅包含两个工具——无需认证:
工具用途
search_docs
基于RAG的搜索工具,可检索ImageKit文档、指南、API参考、SDK、社区帖子
transformation_builder
根据自然语言描述生成转换URL

Routing Table

路由表

NeedRoute To
List, delete, move, copy files
mcp_imagekit_api_execute
(write TS code)
Folder operations
mcp_imagekit_api_execute
(write TS code)
File metadata, tags, custom fields
mcp_imagekit_api_execute
(write TS code)
Bulk operations
mcp_imagekit_api_execute
(write TS code)
Cache purge
mcp_imagekit_api_execute
(write TS code)
URL endpoints, origins
mcp_imagekit_api_execute
(write TS code)
Find SDK method signatures/types
mcp_imagekit_api_search_doc
Upload filesUse
mcp_imagekit_api_execute
with
client.files.upload()
only URL-based uploads work; local files cannot be passed. Read the
upload-files
skill first.
How to do something in ImageKit
mcp_imagekit_devtools_search_docs
Build a transformation URL
mcp_imagekit_devtools_transformation_builder
Find SDK usage or API parameters
mcp_imagekit_devtools_search_docs
Verify feature exists or find limits
mcp_imagekit_devtools_search_docs
Search / filter / list assets
mcp_imagekit_api_execute
(write TS code) — read
search-assets
skill first
Integrate ImageKit into a framework/SDK/CMSread
imagekit-integrations
skill first
需求路由至
列出、删除、移动、复制文件
mcp_imagekit_api_execute
(编写TS代码)
文件夹操作
mcp_imagekit_api_execute
(编写TS代码)
文件元数据、标签、自定义字段
mcp_imagekit_api_execute
(编写TS代码)
批量操作
mcp_imagekit_api_execute
(编写TS代码)
缓存清除
mcp_imagekit_api_execute
(编写TS代码)
URL端点、源站
mcp_imagekit_api_execute
(编写TS代码)
查找SDK方法签名/类型
mcp_imagekit_api_search_doc
上传文件使用
mcp_imagekit_api_execute
调用
client.files.upload()
——仅支持基于URL的上传;无法传递本地文件。请先阅读
upload-files
技能文档。
了解ImageKit的操作方法
mcp_imagekit_devtools_search_docs
生成转换URL
mcp_imagekit_devtools_transformation_builder
查找SDK用法或API参数
mcp_imagekit_devtools_search_docs
验证功能是否存在或查找限制
mcp_imagekit_devtools_search_docs
搜索/筛选/列出资源
mcp_imagekit_api_execute
(编写TS代码)——请先阅读
search-assets
技能文档
将ImageKit集成到框架/SDK/CMS请先阅读
imagekit-integrations
技能文档

Searching / Filtering Assets

搜索/筛选资源

When listing assets with
client.assets.list
, filter on the server instead of fetching everything and filtering in code. Read the
search-assets
skill first
— it is the canonical reference for the Lucene-like
searchQuery
syntax, when to use top-level params vs a
searchQuery
, and how to narrow the returned
File
/
Folder
results.
使用
client.assets.list
列出资源时,在服务器端进行筛选,而非获取所有资源后在代码中筛选。请先阅读
search-assets
技能文档
——它是类Lucene语法
searchQuery
的权威参考,涵盖何时使用顶级参数而非
searchQuery
,以及如何缩小返回的
File
/
Folder
结果范围。

Integration Use Cases

集成用例

When the task is to integrate ImageKit into a specific technology (front-end, back-end, mobile, CMS, external storage, upload widgets, URL generation, etc.), read the
imagekit-integrations
skill
to find the right SDK/plugin and what it covers before writing code.
当任务是将ImageKit集成到特定技术(前端、后端、移动端、CMS、外部存储、上传组件、URL生成等)时,请先阅读
imagekit-integrations
技能文档
,以找到合适的SDK/插件及其覆盖范围,再编写代码。

Before Calling imagekit_api

调用imagekit_api前的准备

Use the
imagekit-sdk-reference
skill
before constructing any TypeScript code that calls
mcp_imagekit_api_*
tools. That skill provides complete SDK method signatures, parameters, return types, error handling patterns, and examples to ensure correct API calls and proper data handling.
在构建任何调用
mcp_imagekit_api_*
工具的TypeScript代码前,请使用
imagekit-sdk-reference
技能
。该技能提供完整的SDK方法签名、参数、返回类型、错误处理模式及示例,确保API调用正确且数据处理得当。

Critical Rules

重要规则

  1. Uploads are URL-only
    client.files.upload()
    via
    mcp_imagekit_api_execute
    only accepts a public URL string. Local files cannot be uploaded (no file bytes, streams, or Buffers). Read the
    upload-files
    skill first.
  2. ALWAYS call
    search_docs
    before writing any ImageKit SDK code
    — do not rely on training data for method signatures or parameters.
  3. Do NOT read library source code to figure out usage
    search_docs
    returns official docs and working examples. Only read source code as a last resort when docs fail.
  4. Use
    transformation_builder
    instead of hand-crafting transformation URLs
    — it knows correct parameter syntax and ordering.
  5. Filter
    client.assets.list
    server-side, not in code
    — read the
    search-assets
    skill for how to choose between top-level params and a
    searchQuery
    .
  1. 仅支持URL上传——通过
    mcp_imagekit_api_execute
    调用
    client.files.upload()
    仅接受公共URL字符串。无法上传本地文件(不支持文件字节、流或Buffer)。请先阅读
    upload-files
    技能文档。
  2. 编写任何ImageKit SDK代码前务必调用
    search_docs
    ——不要依赖训练数据获取方法签名或参数。
  3. 不要通过阅读库源代码来了解用法——
    search_docs
    会返回官方文档和可用示例。仅当文档失效时,才将阅读源代码作为最后手段。
  4. 使用
    transformation_builder
    而非手动编写转换URL
    ——它知晓正确的参数语法和顺序。
  5. 在服务器端筛选
    client.assets.list
    结果,而非在代码中筛选
    ——请阅读
    search-assets
    技能文档,了解如何选择使用顶级参数还是
    searchQuery