让大模型理解如何使用。
用简明文档说明支持的输入、返回的结果以及能力边界。
选择合适的接入资料
| 资料 | 用途 |
|---|---|
| llms.txt | 用于发现服务和查找文档的简短索引。 |
| Markdown 概览 | 支持的能力、文件格式、输出和限制。 |
| OpenAPI | REST 路由、身份验证及请求与响应结构。 |
| MCP 工具定义 | 两个可用工具的输入结构。 |
| Python 示例 | 上传、提交任务、限时轮询和身份验证下载。 |
可以交给编程助手的任务
可复制示例
Read the RedactTool overview and API reference from this documentation site. Build a server-side integration to upload a DOCX file, replace detected sensitive information with placeholders, poll the job, and save its output. Use environment variables for the base URL and API key. Do not send a file until I provide an authorized input. Preserve job IDs and idempotency keys. Handle queued, running, completed, failed, expiry and rate limits. Do not assume an SDK, OAuth, webhook, or permanent API key exists.
明确的能力边界
| 当前支持 | 暂不支持或保证 |
|---|---|
| 单个任务内的占位符 | 跨文件身份一致性或还原对照表 |
| PDF, DOCX, XLSX, TXT, MD | 任意文件类型或所有 Office 排版变体 |
| 异步状态轮询 | Webhook、SSE 进度推送或取消接口 |
| 使用 Bearer 身份验证的 MCP | 通用 OAuth 安装或远程网址导入 |
这些文档说明当前支持的 API 和 MCP 用法。接入前请了解限制;不要将密钥或敏感文件放入公开提示词或问题报告。