@promptbook/vercel 0.112.0-15 → 0.112.0-17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # ✨ Promptbook: AI Agents
4
4
 
5
- Turn your company's scattered knowledge into AI ready Books
5
+ Create persistent AI agents that turn your company's scattered knowledge into action powered by the [Agents Server](https://gallery.ptbk.io/)
6
6
 
7
7
 
8
8
 
@@ -118,11 +118,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
118
118
 
119
119
  ## 📖 The Book Whitepaper
120
120
 
121
+ Promptbook lets you create **persistent AI agents** that work on real goals for your company. The [**Agents Server**](https://gallery.ptbk.io/) is the heart of the project — a place where your AI agents live, remember context, collaborate in teams, and get things done.
122
+
121
123
  Nowadays, the biggest challenge for most business applications isn't the raw capabilities of AI models. Large language models such as GPT-5.2 and Claude-4.5 are incredibly capable.
122
124
 
123
125
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
124
126
 
125
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
127
+ In Promptbook, you define your agents **using simple Books** — a human-readable language that is explicit, easy to understand and write, reliable, and highly portable. You then deploy them to the **Agents Server**, where they run persistently and work toward their goals.
126
128
 
127
129
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
128
130
 
@@ -130,8 +132,13 @@ In Promptbook, you can define your context **using simple Books** that are very
130
132
  <br/>
131
133
  **PERSONA** You are a company lawyer.<br/>
132
134
  Your job is to provide legal advice and support to the company and its employees.<br/>
135
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
133
136
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
134
- TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
137
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
138
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
139
+ **USE EMAIL**<br/>
140
+ **USE BROWSER**<br/>
141
+ **TEAM** You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
135
142
 
136
143
  </td></tr></table>
137
144
 
@@ -154,6 +161,22 @@ Personas define the character of your AI persona, its role, and how it should in
154
161
  **<ins>Paul Smith & Associés</ins>**<br/>
155
162
  <br/>
156
163
  **PERSONA** You are a company lawyer.<br/>
164
+ Your job is to provide legal advice and support to the company and its employees.<br/>
165
+
166
+ </td></tr></table>
167
+
168
+ #### `Goal` commitment
169
+
170
+ Goals define what the agent should actively work toward. Unlike a chatbot that only responds when asked, an agent with goals takes initiative and works on tasks persistently on the Agents Server.
171
+
172
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
173
+
174
+ **<ins>Paul Smith & Associés</ins>**<br/>
175
+ <br/>
176
+ **PERSONA** You are a company lawyer.<br/>
177
+ Your job is to provide legal advice and support to the company and its employees.<br/>
178
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
179
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
157
180
 
158
181
  </td></tr></table>
159
182
 
@@ -171,9 +194,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
171
194
  <br/>
172
195
  **PERSONA** You are a company lawyer.<br/>
173
196
  Your job is to provide legal advice and support to the company and its employees.<br/>
174
- You are knowledgeable, professional, and detail-oriented.<br/>
175
- <br/>
176
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
197
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
198
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
199
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
177
200
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
178
201
 
179
202
  </td></tr></table>
@@ -190,13 +213,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
190
213
  <br/>
191
214
  **PERSONA** You are a company lawyer.<br/>
192
215
  Your job is to provide legal advice and support to the company and its employees.<br/>
193
- You are knowledgeable, professional, and detail-oriented.<br/>
216
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
217
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
218
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
219
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
220
+ **RULE** Never provide legal advice about criminal law.<br/>
221
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
222
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
223
+
224
+ </td></tr></table>
225
+
226
+ #### `Use` commitments
227
+
228
+ Use commitments grant the agent real capabilities — tools it can use to interact with the outside world. `USE EMAIL` lets the agent send emails, `USE BROWSER` lets it access and read web content, `USE SEARCH ENGINE` lets it search the web, and many more.
229
+
230
+ These are what turn a chatbot into a persistent agent that actually does work.
231
+
232
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
233
+
234
+ **<ins>Paul Smith & Associés</ins>**<br/>
194
235
  <br/>
195
- **RULE** Always ensure compliance with laws and regulations.<br/>
236
+ **PERSONA** You are a company lawyer.<br/>
237
+ Your job is to provide legal advice and support to the company and its employees.<br/>
238
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
239
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
240
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
196
241
  **RULE** Never provide legal advice outside your area of expertise.<br/>
197
242
  **RULE** Never provide legal advice about criminal law.<br/>
198
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
243
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
199
244
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
245
+ **USE EMAIL**<br/>
246
+ **USE BROWSER**<br/>
247
+ **USE SEARCH ENGINE**<br/>
200
248
 
201
249
  </td></tr></table>
202
250
 
@@ -210,32 +258,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
210
258
  <br/>
211
259
  **PERSONA** You are a company lawyer.<br/>
212
260
  Your job is to provide legal advice and support to the company and its employees.<br/>
213
- You are knowledgeable, professional, and detail-oriented.<br/>
214
- <br/>
215
- **RULE** Always ensure compliance with laws and regulations.<br/>
261
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
262
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
263
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
216
264
  **RULE** Never provide legal advice outside your area of expertise.<br/>
217
265
  **RULE** Never provide legal advice about criminal law.<br/>
218
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
266
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
219
267
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
220
- TEAM You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
268
+ **USE EMAIL**<br/>
269
+ **USE BROWSER**<br/>
270
+ **USE SEARCH ENGINE**<br/>
271
+ **TEAM** You are part of the legal team of Paul Smith & Associés, you discuss with {Emily White}, the head of the compliance department. {George Brown} is expert in corporate law and {Sophia Black} is expert in labor law.<br/>
221
272
 
222
273
  </td></tr></table>
223
274
 
224
-
225
-
226
275
  ### Promptbook Ecosystem
227
276
 
228
- !!!@@@
277
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
229
278
 
230
- #### Promptbook Server
279
+ #### Agents Server
231
280
 
232
- !!!@@@
281
+ The [**Agents Server**](https://gallery.ptbk.io/) is the primary way to use Promptbook. It is a web application where your AI agents live and work. You can create agents, give them knowledge and rules using the Book language, organize them into teams, and let them work on goals persistently. The Agents Server provides a UI for managing agents, an API for integrating them into your applications, and can be self-hosted via [Docker](https://hub.docker.com/r/hejny/promptbook/) or deployed on Vercel.
233
282
 
234
283
  #### Promptbook Engine
235
284
 
236
- !!!@@@
237
-
238
-
285
+ The [Promptbook Engine](https://github.com/webgptorg/promptbook) is the open-source core that powers everything. It parses the Book language, applies commitments, manages LLM provider integrations, and executes agents. The Agents Server is built on top of the Engine. If you need to embed agent capabilities directly into your own application, you can use the Engine as a standalone TypeScript/JavaScript library via [NPM packages](https://www.npmjs.com/package/@promptbook/core).
239
286
 
240
287
 
241
288
 
@@ -249,7 +296,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
249
296
 
250
297
  ## 💜 The Promptbook Project
251
298
 
252
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
299
+ Promptbook project is an ecosystem centered around the **Agents Server** — a platform for creating, deploying, and running persistent AI agents. Following is a list of the most important pieces of the project:
253
300
 
254
301
  <table>
255
302
  <thead>
@@ -260,9 +307,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
260
307
  </thead>
261
308
  <tbody>
262
309
  <tr>
263
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
310
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
264
311
  <td>
265
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
312
+ The primary way to use Promptbook. A production-ready platform where your AI agents live create, manage, deploy, and interact with persistent agents that work on goals. Available as a hosted service or <a href="https://hub.docker.com/r/hejny/promptbook/">self-hosted via Docker</a>.
266
313
  </td>
267
314
  </tr>
268
315
  <tr>
@@ -276,17 +323,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
276
323
  <tr>
277
324
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
278
325
  <td>
279
- Promptbook engine can run AI agents based on Book language.
280
- It is released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a> and <a href="https://hub.docker.com/r/hejny/promptbook">Promptbook Agent Server as Docker Package</a>
281
- Agent Server is based on Promptbook Engine.
326
+ The open-source core that powers the Agents Server. Can also be used as a standalone TypeScript/JavaScript library to embed agent capabilities into your own applications.
327
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
282
328
  </td>
283
329
  </tr>
284
330
 
285
331
  </tbody>
286
332
  </table>
287
333
 
288
-
289
-
290
334
  ### 🌐 Community & Social Media
291
335
 
292
336
  Join our growing community of developers and users:
@@ -343,8 +387,6 @@ Join our growing community of developers and users:
343
387
 
344
388
 
345
389
 
346
-
347
-
348
390
  ## 📚 Documentation
349
391
 
350
392
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -353,9 +395,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
353
395
 
354
396
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
355
397
 
356
- ## 📦 Packages _(for developers)_
398
+ ## 📦 Deployment & Packages
399
+
400
+ The fastest way to get started is with the **Agents Server**:
357
401
 
358
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
402
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
403
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
404
+
405
+ ### NPM Packages _(for developers embedding the Engine)_
406
+
407
+ If you want to embed the Promptbook Engine directly into your application, the library is divided into several packages published from a [single monorepo](https://github.com/webgptorg/promptbook).
359
408
  You can install all of them at once:
360
409
 
361
410
  ```bash
@@ -374,7 +423,6 @@ Or you can install them separately:
374
423
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
375
424
  - ⭐ **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
376
425
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
377
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
378
426
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
379
427
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
380
428
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -396,8 +444,7 @@ Or you can install them separately:
396
444
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
397
445
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
398
446
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
399
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
400
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
447
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
401
448
 
402
449
 
403
450
 
@@ -421,8 +468,6 @@ The following glossary is used to clarify certain concepts:
421
468
 
422
469
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
423
470
 
424
-
425
-
426
471
  ### 💯 Core concepts
427
472
 
428
473
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -484,31 +529,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
484
529
 
485
530
 
486
531
 
532
+ ## � Agents Server
533
+
534
+ The **[Agents Server](https://gallery.ptbk.io/)** is the primary way to use Promptbook. It is a production-ready platform where you create, deploy, and manage persistent AI agents that work toward goals. Agents remember context across conversations, collaborate in teams, and follow the rules and knowledge you define in the Book language.
535
+
536
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
537
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
538
+ - **API** for integrating agents into your own applications
539
+
487
540
  ## 🚂 Promptbook Engine
488
541
 
542
+ The Engine is the open-source core that powers the Agents Server. If you need to embed agent capabilities directly into your TypeScript/JavaScript application, you can use it as a standalone library.
543
+
489
544
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
490
545
 
491
546
  ## ➕➖ When to use Promptbook?
492
547
 
493
548
  ### ➕ When to use
494
549
 
495
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
496
- - When you want to **separate code from text prompts**
497
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
498
- - When you want to **orchestrate multiple prompts** together
499
- - When you want to **reuse** parts of prompts in multiple places
500
- - When you want to **version** your prompts and **test multiple versions**
501
- - When you want to **log** the execution of prompts and backtrace the issues
550
+ - When you want to **deploy persistent AI agents** that work on goals for your company
551
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
552
+ - When you want agents that **collaborate in teams** and consult each other
553
+ - When you need to **integrate AI agents into your existing applications** via API
554
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
555
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
556
+ - When you want to **version** your agent definitions and **test multiple versions**
557
+ - When you want to **log** agent execution and backtrace issues
502
558
 
503
559
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
504
560
 
505
561
  ### ➖ When not to use
506
562
 
507
- - When you have already implemented single simple prompt and it works fine for your job
563
+ - When a single simple prompt already works fine for your job
508
564
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
509
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
565
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
510
566
  - When you need to use something other than JavaScript or TypeScript _(other languages are on the way, [see the discussion](https://github.com/webgptorg/promptbook/discussions/101))_
511
- - When your main focus is on something other than text - like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
567
+ - When your main focus is on something other than text like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
512
568
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
513
569
 
514
570
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -16,7 +16,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
16
16
  * @generated
17
17
  * @see https://github.com/webgptorg/promptbook
18
18
  */
19
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-15';
19
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
20
20
  /**
21
21
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
22
22
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.112.0-14`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/vercel",
3
- "version": "0.112.0-15",
3
+ "version": "0.112.0-17",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -97,7 +97,7 @@
97
97
  "module": "./esm/index.es.js",
98
98
  "typings": "./esm/typings/src/_packages/vercel.index.d.ts",
99
99
  "peerDependencies": {
100
- "@promptbook/core": "0.112.0-15"
100
+ "@promptbook/core": "0.112.0-17"
101
101
  },
102
102
  "dependencies": {
103
103
  "colors": "1.4.0",
package/umd/index.umd.js CHANGED
@@ -22,7 +22,7 @@
22
22
  * @generated
23
23
  * @see https://github.com/webgptorg/promptbook
24
24
  */
25
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-15';
25
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-17';
26
26
  /**
27
27
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
28
28
  * Note: [💞] Ignore a discrepancy between file name and entity name
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.112.0-14`).
18
+ * It follows semantic versioning (e.g., `0.112.0-16`).
19
19
  *
20
20
  * @generated
21
21
  */