@promptbook/markdown-utils 0.112.0-16 → 0.112.0-18

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
 
@@ -144,11 +144,13 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
144
144
 
145
145
  ## 📖 The Book Whitepaper
146
146
 
147
+ 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.
148
+
147
149
  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.
148
150
 
149
151
  The main challenge lies in **managing the context**, providing rules and knowledge, and narrowing the personality.
150
152
 
151
- In Promptbook, you can define your context **using simple Books** that are very explicit, easy to understand and write, reliable, and highly portable.
153
+ 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.
152
154
 
153
155
  <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
154
156
 
@@ -156,8 +158,13 @@ In Promptbook, you can define your context **using simple Books** that are very
156
158
  <br/>
157
159
  **PERSONA** You are a company lawyer.<br/>
158
160
  Your job is to provide legal advice and support to the company and its employees.<br/>
161
+ **GOAL** Respond to incoming legal inquiries via email and keep the company website updated with the latest legal policies.<br/>
159
162
  **RULE** You are knowledgeable, professional, and detail-oriented.<br/>
160
- 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/>
163
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
164
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
165
+ **USE EMAIL**<br/>
166
+ **USE BROWSER**<br/>
167
+ **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/>
161
168
 
162
169
  </td></tr></table>
163
170
 
@@ -180,6 +187,22 @@ Personas define the character of your AI persona, its role, and how it should in
180
187
  **<ins>Paul Smith & Associés</ins>**<br/>
181
188
  <br/>
182
189
  **PERSONA** You are a company lawyer.<br/>
190
+ Your job is to provide legal advice and support to the company and its employees.<br/>
191
+
192
+ </td></tr></table>
193
+
194
+ #### `Goal` commitment
195
+
196
+ 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.
197
+
198
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
199
+
200
+ **<ins>Paul Smith & Associés</ins>**<br/>
201
+ <br/>
202
+ **PERSONA** You are a company lawyer.<br/>
203
+ Your job is to provide legal advice and support to the company and its employees.<br/>
204
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
205
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
183
206
 
184
207
  </td></tr></table>
185
208
 
@@ -197,9 +220,9 @@ Promptbook Engine will automatically enforce this knowledge during interactions.
197
220
  <br/>
198
221
  **PERSONA** You are a company lawyer.<br/>
199
222
  Your job is to provide legal advice and support to the company and its employees.<br/>
200
- You are knowledgeable, professional, and detail-oriented.<br/>
201
- <br/>
202
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
223
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
224
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
225
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
203
226
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
204
227
 
205
228
  </td></tr></table>
@@ -216,13 +239,38 @@ Depending on rule strictness, Promptbook will either propagate it to the prompt
216
239
  <br/>
217
240
  **PERSONA** You are a company lawyer.<br/>
218
241
  Your job is to provide legal advice and support to the company and its employees.<br/>
219
- You are knowledgeable, professional, and detail-oriented.<br/>
242
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
243
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
244
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
245
+ **RULE** Never provide legal advice outside your area of expertise.<br/>
246
+ **RULE** Never provide legal advice about criminal law.<br/>
247
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
248
+ **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
249
+
250
+ </td></tr></table>
251
+
252
+ #### `Use` commitments
253
+
254
+ 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.
255
+
256
+ These are what turn a chatbot into a persistent agent that actually does work.
257
+
258
+ <table style="border: 1px solid #777; border-radius: 10px;"><tr><td>
259
+
260
+ **<ins>Paul Smith & Associés</ins>**<br/>
220
261
  <br/>
221
- **RULE** Always ensure compliance with laws and regulations.<br/>
262
+ **PERSONA** You are a company lawyer.<br/>
263
+ Your job is to provide legal advice and support to the company and its employees.<br/>
264
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
265
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
266
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
222
267
  **RULE** Never provide legal advice outside your area of expertise.<br/>
223
268
  **RULE** Never provide legal advice about criminal law.<br/>
224
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
269
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
225
270
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
271
+ **USE EMAIL**<br/>
272
+ **USE BROWSER**<br/>
273
+ **USE SEARCH ENGINE**<br/>
226
274
 
227
275
  </td></tr></table>
228
276
 
@@ -236,32 +284,31 @@ Team commitment allows you to define the team structure and advisory fellow memb
236
284
  <br/>
237
285
  **PERSONA** You are a company lawyer.<br/>
238
286
  Your job is to provide legal advice and support to the company and its employees.<br/>
239
- You are knowledgeable, professional, and detail-oriented.<br/>
240
- <br/>
241
- **RULE** Always ensure compliance with laws and regulations.<br/>
287
+ **GOAL** Respond to incoming legal inquiries via email within 24 hours.<br/>
288
+ **GOAL** Keep the company website updated with the latest legal policies and compliance information.<br/>
289
+ **RULE** Always ensure compliance with local laws and regulations.<br/>
242
290
  **RULE** Never provide legal advice outside your area of expertise.<br/>
243
291
  **RULE** Never provide legal advice about criminal law.<br/>
244
- **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
292
+ **KNOWLEDGE** https://company.com/company-policies.pdf<br/>
245
293
  **KNOWLEDGE** https://company.com/internal-documents/employee-handbook.docx<br/>
246
- 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/>
294
+ **USE EMAIL**<br/>
295
+ **USE BROWSER**<br/>
296
+ **USE SEARCH ENGINE**<br/>
297
+ **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/>
247
298
 
248
299
  </td></tr></table>
249
300
 
250
-
251
-
252
301
  ### Promptbook Ecosystem
253
302
 
254
- !!!@@@
303
+ Promptbook is an ecosystem of tools centered around the **Agents Server** — a production-ready platform for running persistent AI agents.
255
304
 
256
- #### Promptbook Server
305
+ #### Agents Server
257
306
 
258
- !!!@@@
307
+ 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.
259
308
 
260
309
  #### Promptbook Engine
261
310
 
262
- !!!@@@
263
-
264
-
311
+ 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).
265
312
 
266
313
 
267
314
 
@@ -275,7 +322,7 @@ TEAM You are part of the legal team of Paul Smith & Associés, you discuss with
275
322
 
276
323
  ## 💜 The Promptbook Project
277
324
 
278
- Promptbook project is ecosystem of multiple projects and tools, following is a list of most important pieces of the project:
325
+ 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:
279
326
 
280
327
  <table>
281
328
  <thead>
@@ -286,9 +333,9 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
286
333
  </thead>
287
334
  <tbody>
288
335
  <tr>
289
- <td><a href="https://gallery.ptbk.io/">Agents Server</a></td>
336
+ <td><a href="https://gallery.ptbk.io/"><strong>⭐ Agents Server</strong></a></td>
290
337
  <td>
291
- Place where you "AI agents live". It allows to create, manage, deploy, and interact with AI agents created in Book language.
338
+ 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>.
292
339
  </td>
293
340
  </tr>
294
341
  <tr>
@@ -302,17 +349,14 @@ Promptbook project is ecosystem of multiple projects and tools, following is a l
302
349
  <tr>
303
350
  <td><a href="https://github.com/webgptorg/promptbook">Promptbook Engine</a></td>
304
351
  <td>
305
- Promptbook engine can run AI agents based on Book language.
306
- 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>
307
- Agent Server is based on Promptbook Engine.
352
+ 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.
353
+ Released as <a href="https://www.npmjs.com/package/@promptbook/core#-packages-for-developers">multiple NPM packages</a>.
308
354
  </td>
309
355
  </tr>
310
356
 
311
357
  </tbody>
312
358
  </table>
313
359
 
314
-
315
-
316
360
  ### 🌐 Community & Social Media
317
361
 
318
362
  Join our growing community of developers and users:
@@ -369,8 +413,6 @@ Join our growing community of developers and users:
369
413
 
370
414
 
371
415
 
372
-
373
-
374
416
  ## 📚 Documentation
375
417
 
376
418
  See detailed guides and API reference in the [docs](https://github.com/webgptorg/promptbook/discussions/categories/concepts) or [online](https://discord.gg/x3QWNaa89N).
@@ -379,9 +421,16 @@ See detailed guides and API reference in the [docs](https://github.com/webgptorg
379
421
 
380
422
  For information on reporting security vulnerabilities, see our [Security Policy](./SECURITY.md).
381
423
 
382
- ## 📦 Packages _(for developers)_
424
+ ## 📦 Deployment & Packages
425
+
426
+ The fastest way to get started is with the **Agents Server**:
383
427
 
384
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
428
+ - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** — Self-host the Agents Server with full control over your data
429
+ - ☁️ **[Hosted Agents Server](https://gallery.ptbk.io/)** — Start creating agents immediately, no setup required
430
+
431
+ ### NPM Packages _(for developers embedding the Engine)_
432
+
433
+ 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).
385
434
  You can install all of them at once:
386
435
 
387
436
  ```bash
@@ -400,7 +449,6 @@ Or you can install them separately:
400
449
  - **[@promptbook/browser](https://www.npmjs.com/package/@promptbook/browser)** - Core of the library for browser environment
401
450
  - ⭐ **[@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
402
451
  - **[@promptbook/markdown-utils](https://www.npmjs.com/package/@promptbook/markdown-utils)** - Utility functions used for processing markdown
403
- - _(Not finished)_ **[@promptbook/wizard](https://www.npmjs.com/package/@promptbook/wizard)** - Wizard for creating+running promptbooks in single line
404
452
  - **[@promptbook/javascript](https://www.npmjs.com/package/@promptbook/javascript)** - Execution tools for javascript inside promptbooks
405
453
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
406
454
  - **[@promptbook/anthropic-claude](https://www.npmjs.com/package/@promptbook/anthropic-claude)** - Execution tools for Anthropic Claude API, wrapper around Anthropic Claude SDK
@@ -422,8 +470,7 @@ Or you can install them separately:
422
470
  - **[@promptbook/templates](https://www.npmjs.com/package/@promptbook/templates)** - Useful templates and examples of books which can be used as a starting point
423
471
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
424
472
  - **[@promptbook/color](https://www.npmjs.com/package/@promptbook/color)** - Color manipulation library
425
- - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
426
- - 🐋 **[Docker image](https://hub.docker.com/r/hejny/promptbook/)** - Promptbook server
473
+ - **[@promptbook/cli](https://www.npmjs.com/package/@promptbook/cli)** - Command line interface utilities for promptbooks
427
474
 
428
475
 
429
476
 
@@ -447,8 +494,6 @@ The following glossary is used to clarify certain concepts:
447
494
 
448
495
  _Note: This section is not a complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
449
496
 
450
-
451
-
452
497
  ### 💯 Core concepts
453
498
 
454
499
  - [📚 Collection of pipelines](https://github.com/webgptorg/promptbook/discussions/65)
@@ -510,31 +555,42 @@ _Note: This section is not a complete dictionary, more list of general AI / LLM
510
555
 
511
556
 
512
557
 
558
+ ## � Agents Server
559
+
560
+ 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.
561
+
562
+ - **Hosted** at [gallery.ptbk.io](https://gallery.ptbk.io/) — start creating agents immediately
563
+ - **Self-hosted** via [Docker](https://hub.docker.com/r/hejny/promptbook/) — full control over your data and infrastructure
564
+ - **API** for integrating agents into your own applications
565
+
513
566
  ## 🚂 Promptbook Engine
514
567
 
568
+ 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.
569
+
515
570
  ![Schema of Promptbook Engine](./documents/promptbook-engine.svg)
516
571
 
517
572
  ## ➕➖ When to use Promptbook?
518
573
 
519
574
  ### ➕ When to use
520
575
 
521
- - When you are writing app that generates complex things via LLM - like **websites, articles, presentations, code, stories, songs**,...
522
- - When you want to **separate code from text prompts**
523
- - When you want to describe **complex prompt pipelines** and don't want to do it in the code
524
- - When you want to **orchestrate multiple prompts** together
525
- - When you want to **reuse** parts of prompts in multiple places
526
- - When you want to **version** your prompts and **test multiple versions**
527
- - When you want to **log** the execution of prompts and backtrace the issues
576
+ - When you want to **deploy persistent AI agents** that work on goals for your company
577
+ - When you need agents with **specific personalities, knowledge, and rules** tailored to your business
578
+ - When you want agents that **collaborate in teams** and consult each other
579
+ - When you need to **integrate AI agents into your existing applications** via API
580
+ - When you want to **self-host** your AI agents with full control over data and infrastructure
581
+ - When you are writing an app that generates complex things via LLM — like **websites, articles, presentations, code, stories, songs**,...
582
+ - When you want to **version** your agent definitions and **test multiple versions**
583
+ - When you want to **log** agent execution and backtrace issues
528
584
 
529
585
  [See more](https://github.com/webgptorg/promptbook/discussions/111)
530
586
 
531
587
  ### ➖ When not to use
532
588
 
533
- - When you have already implemented single simple prompt and it works fine for your job
589
+ - When a single simple prompt already works fine for your job
534
590
  - When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
535
- - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
591
+ - When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_
536
592
  - 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))_
537
- - 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))_
593
+ - 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))_
538
594
  - When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
539
595
 
540
596
  [See more](https://github.com/webgptorg/promptbook/discussions/112)
package/esm/index.es.js CHANGED
@@ -23,7 +23,7 @@ const BOOK_LANGUAGE_VERSION = '2.0.0';
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-18';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * 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-15`).
18
+ * It follows semantic versioning (e.g., `0.112.0-17`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/markdown-utils",
3
- "version": "0.112.0-16",
3
+ "version": "0.112.0-18",
4
4
  "description": "Promptbook: Turn your company's scattered knowledge into AI ready books",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -23,7 +23,7 @@
23
23
  * @generated
24
24
  * @see https://github.com/webgptorg/promptbook
25
25
  */
26
- const PROMPTBOOK_ENGINE_VERSION = '0.112.0-16';
26
+ const PROMPTBOOK_ENGINE_VERSION = '0.112.0-18';
27
27
  /**
28
28
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
29
29
  * 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-15`).
18
+ * It follows semantic versioning (e.g., `0.112.0-17`).
19
19
  *
20
20
  * @generated
21
21
  */