Go
MIT License
Fastly API - OpenAPI 规范
此存储库包含Fastly API的全面、非官方 OpenAPI 3.0 规范，该规范是通过对公开的 API 文档进行逆向工程创建的。与官方网页文档相比，它具有显著增强的文档，包含详细的描述、示例和针对人类开发人员和 AI 代理优化的结构化模式。
关键组件
该项目提供了使用 Fastly API 的三个关键资源：
- 完整的 OpenAPI 规范（
fastly-openapi.yaml） - 适用于所有 Fastly API 端点的全面 OpenAPI 3.0 架构 - AI 优化规范(
fastly-openapi-mcp.yaml) - 针对 AI 代理使用情况优化的精简子集 - 模型上下文协议服务器(
fastly-mcp-server/) - 一种 MCP 服务器实现，允许 AI 模型通过标准化协议与 Fastly 交互
用于 AI 集成的 MCP 服务器
该存储库包含 Fastly 的完整模型上下文协议 (MCP)服务器，可在 NPM 上获取：
该 MCP 服务器使 AI 助手和代理能够：
- 通过自然语言与 Fastly 服务进行交互
- 管理 CDN 配置、缓存设置和安全功能
- 执行内容清除、统计数据收集和服务部署
- 通过标准化界面访问所有主要的 Fastly 功能
请参阅fastly-mcp-server目录以了解详细的使用示例和配置选项。
免责声明
本规范为非官方规范，Fastly 不对其提供任何认可、支持或保证。本规范可能不完整或包含不准确之处。本规范“按原样”提供，不提供任何形式的担保。
特征
- Fastly CDN API 的全面 OpenAPI 3.0 架构
- 增强的文档，其清晰度和详细程度超越了官方网站文档
- 专为大型语言模型和 AI 代理使用而设计的AI 优化模式
- 带有操作上下文和示例的详细端点描述
- 所有请求和响应对象的完整模式定义
- 支持所有主要的 Fastly API 功能：
- 服务管理
- 域配置
- 后端管理
- VCL 操作
- 缓存控制
- 清除操作
- 边缘词典
- WAF 安全
- 日志记录端点
- 统计数据和指标
- 边缘计算
规格
该存储库包含两个 OpenAPI 规范：
fastly-openapi.yaml
Fastly API 的完整规范，包含所有端点、参数和架构。本规范：
- 提供比官方网站文档更全面、更结构化的文档
- 包含解释使用环境（而不仅仅是参数）的详细描述
- 包含所有操作和数据模式的一致示例
- 对于全面的 API 文档和客户端生成很有用
fastly-openapi-mcp.yaml
精简的 API 子集，专门针对 AI 代理交互进行了优化。此规范：
- 仅包含常见 Fastly 任务最常用的端点
- 专注于日常管理所需的核心操作
- 保留针对 AI 理解进行优化的详细描述和示例
- 优先考虑对话界面中最有用的端点
- 遵循与常见用户工作流程相匹配的基于任务的组织
- 减少人工智能环境的代币消耗，同时最大化效用
MCP 版本非常适合与需要通过自然语言界面与 Fastly 交互的 AI 助手和工具集成。
用法
查看文档
您可以使用以下工具根据这些规范生成交互式文档：
例子：
验证
验证规范：
代码生成
这些规范可与 OpenAPI 代码生成器一起使用，以创建各种编程语言的客户端库：
特工准备就绪
这两种规范均设计为“代理就绪”——针对 AI 代理和工具的使用进行了优化。它们遵循机器可读性的最佳实践：
- 详细的操作说明，信息密度比官方文档更高
- 相关端点之间的一致命名模式
- 完整的架构文档，包含详尽的属性描述
- 所有操作和架构组件的示例
- 组件之间结构合理的引用和关系
MCP 版本通过以下方式进一步提高了代理准备程度：
- 为常见任务精心挑选高价值端点
- 以任务为导向的组织与用户意图相一致
- 增强描述，重点关注对话上下文
- 删除日常使用中很少出现的专用端点
- 针对 AI 环境中的代币消耗进行优化
有关 MCP 规范的具体用例，请参阅subset.md ，其中概述了常见的对话任务和相应的 API 工作流程。
MCP 服务器使用情况
要将 MCP 服务器与您的 AI 助手配置一起使用：
包子（推荐）
Node.js
注意：Bun 因其卓越的性能和启动时间而成为 fastly-mcp-server 的首选运行时。
有关配置和使用的更多详细信息，请参阅fastly-mcp-server 文档。
资源
Related MCP Servers
- TypeScript
- TypeScriptGPL 3.0
- TypeScriptApache 2.0