Skip to content

Commit df200e0

Browse files
committed
docs: improve SKILL.md with presentation guidance and portal features
1 parent 827e0de commit df200e0

1 file changed

Lines changed: 20 additions & 8 deletions

File tree

agent-pdf/SKILL.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,34 @@ Upload a PDF file as multipart:
2828
curl -X POST https://agent.simplepdf.com -F file=@document.pdf
2929
```
3030

31+
## Presenting the result to the user
32+
33+
Always present the `url` field as a clickable link. This is the primary way users will open the editor.
34+
35+
If you have access to a browser automation tool (e.g. agent-browser, Playwright, chrome-devtools MCP server), offer to open the `url` directly so the user can edit the PDF without leaving the conversation.
36+
37+
The `iframe` and `react` fields are for developers embedding the editor in a web application. Only present these when the user is building a web app.
38+
3139
## Company-specific editor
3240

33-
Add `companyIdentifier` to route to a custom portal:
41+
Add `companyIdentifier` to route to a custom SimplePDF portal:
3442

3543
```
3644
GET https://agent.simplepdf.com?url=https://example.com/form.pdf&companyIdentifier=acme
3745
```
3846

3947
This routes to `acme.simplepdf.com` instead of the default editor.
4048

49+
### Portal features
50+
51+
When using a `companyIdentifier`, the portal owner has access to:
52+
53+
- **Email notifications**: receive an email each time a user submits a filled PDF
54+
- **Webhook notifications**: receive submissions via webhook to integrate with any backend
55+
- **Bring Your Own Storage (BYOS)**: route submitted PDFs directly to the company's own S3 or Azure storage bucket
56+
57+
These features are configured by the portal owner in the SimplePDF admin console. No additional API parameters are needed - they apply automatically when the `companyIdentifier` is set.
58+
4159
## Response
4260

4361
```json
@@ -53,15 +71,9 @@ This routes to `acme.simplepdf.com` instead of the default editor.
5371
|----------|--------------------------------------------------|
5472
| `id` | Unique identifier for the upload (or `url-passthrough` for URL inputs) |
5573
| `url` | Direct link to open the PDF in the SimplePDF editor |
56-
| `iframe` | HTML snippet to embed the editor in a page |
74+
| `iframe` | HTML snippet to embed the editor in a web page |
5775
| `react` | React component snippet using `EmbedPDF` from `@simplepdf/react-embed-pdf` |
5876

59-
## When to use each field
60-
61-
- **`url`**: Present this to the user as a clickable link to edit/fill the PDF
62-
- **`iframe`**: Use when embedding the editor in a web page
63-
- **`react`**: Use when integrating into a React application
64-
6577
## Privacy
6678

6779
- **URL input**: The PDF URL is passed directly to the browser-based editor. The PDF is never downloaded or stored by this service.

0 commit comments

Comments
 (0)