Skip to content

Commit 861b1e9

Browse files
authored
Merge pull request #3 from PSPDFKit-labs/nick/skill/migrate-to-plugin-structure
Migrate from curl-based skill to Python plugin architecture
2 parents 79bf02a + ffaa251 commit 861b1e9

23 files changed

Lines changed: 1042 additions & 895 deletions

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
__pycache__/
2+
*.pyc
3+
.recording-tmp/

README.md

Lines changed: 28 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
<p align="center">
44
<a href="https://www.nutrient.io/api/"><img src="https://img.shields.io/badge/Nutrient-DWS%20API-blue" alt="Nutrient DWS API"></a>
5-
<a href="https://www.npmjs.com/package/@nutrient-sdk/dws-mcp-server"><img src="https://img.shields.io/npm/v/@nutrient-sdk/dws-mcp-server" alt="npm version"></a>
65
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="License"></a>
76
<a href="https://agentskills.io"><img src="https://img.shields.io/badge/Agent%20Skills-compatible-purple" alt="Agent Skills"></a>
87
</p>
@@ -20,8 +19,7 @@
2019
<a href="#30-second-quickstart">Quickstart</a> •
2120
<a href="#real-world-workflows">Workflows</a> •
2221
<a href="#features">Features</a> •
23-
<a href="#supported-agents">40+ Agents</a> •
24-
<a href="#alternative-integrations">MCP &amp; OpenClaw</a>
22+
<a href="#supported-agents">40+ Agents</a>
2523
</p>
2624

2725
---
@@ -44,7 +42,15 @@ export NUTRIENT_API_KEY="pdf_live_..."
4442

4543
> *"Extract the text from invoice.pdf"*
4644
47-
That's it. Your agent now has full document processing capabilities — no MCP setup required.
45+
That's it. Your agent now has full document processing capabilities.
46+
47+
---
48+
49+
## Requirements
50+
51+
- Python 3.10+
52+
- `uv` installed: <https://docs.astral.sh/uv/>
53+
- Nutrient API key
4854

4955
---
5056

@@ -177,62 +183,33 @@ cp -r nutrient-agent-skill/nutrient-document-processing ~/.claude/skills/
177183

178184
---
179185

180-
## Alternative Integrations
181-
182-
### MCP Server (For agents with MCP support)
183-
184-
The **Nutrient DWS MCP Server** provides all operations as native agent tools with file I/O handling and sandboxing.
185-
186-
```bash
187-
npx @nutrient-sdk/dws-mcp-server
188-
```
189-
190-
Add to your MCP config (e.g., `claude_desktop_config.json`):
191-
192-
```json
193-
{
194-
"mcpServers": {
195-
"nutrient-dws": {
196-
"command": "npx",
197-
"args": ["-y", "@nutrient-sdk/dws-mcp-server"],
198-
"env": {
199-
"NUTRIENT_DWS_API_KEY": "YOUR_API_KEY",
200-
"SANDBOX_PATH": "/path/to/working/directory"
201-
}
202-
}
203-
}
204-
}
205-
```
206-
207-
📦 [npm](https://www.npmjs.com/package/@nutrient-sdk/dws-mcp-server) · [GitHub](https://github.com/PSPDFKit/nutrient-dws-mcp-server)
208-
209-
### OpenClaw Plugin
210-
211-
For [OpenClaw](https://openclaw.com) users:
212-
213-
```bash
214-
openclaw plugins install @nutrient-sdk/nutrient-openclaw
215-
```
216-
217-
📦 [npm](https://www.npmjs.com/package/@nutrient-sdk/nutrient-openclaw)
218-
219-
---
220-
221186
## Skill Structure
222187

223188
```
224189
nutrient-document-processing/
225-
├── SKILL.md # Main instructions (loaded by agents)
226-
├── references/
227-
│ └── REFERENCE.md # Full API reference (loaded on demand)
228-
├── LICENSE # Apache-2.0
229-
└── README.md
190+
├── SKILL.md # Main instructions (loaded by agents)
191+
├── scripts/
192+
│ ├── *.py # Single-operation scripts
193+
│ └── lib/common.py # Shared utilities
194+
├── assets/
195+
│ └── templates/
196+
│ └── custom-workflow-template.py # Runtime pipeline template
197+
├── tests/
198+
│ └── testing-guide.md
199+
└── LICENSE # Apache-2.0
230200
```
231201

202+
### Script Model
203+
204+
- `scripts/*.py` are single-operation scripts only.
205+
- Multi-step workflows are generated at runtime in a temporary script from `assets/templates/custom-workflow-template.py`.
206+
- Do not commit runtime pipeline scripts.
207+
232208
## Documentation
233209

234210
- **[SKILL.md](nutrient-document-processing/SKILL.md)** — Agent instructions with setup and operation examples
235-
- **[REFERENCE.md](nutrient-document-processing/references/REFERENCE.md)** — Complete API reference with all endpoints, parameters, and error codes
211+
- **[Testing Guide](nutrient-document-processing/tests/testing-guide.md)** — Manual test procedures
212+
- **[Custom Workflow Template](nutrient-document-processing/assets/templates/custom-workflow-template.py)** — Runtime pipeline starting point
236213
- **[API Playground](https://dashboard.nutrient.io/processor-api/playground/)** — Interactive API testing
237214
- **[Official API Docs](https://www.nutrient.io/guides/dws-processor/)** — Nutrient documentation
238215

0 commit comments

Comments
 (0)