Runbook

Create a new article in a specified book with ID. The article body is in Markdown format. The article will be created in the root folder of the book. You can specify categories for the article by their IDs, which always start with 'ca_' You can retrieve a list of books with runbook-list-books and categories with runbook-list-categories. Markdown format supports:

• Headers: ## H2, ### H3, #### H4. Don't use # H1 as it is reserved for the article title.
• Bold: bold text
• Italic: _italic text_
• Lists: - item or 1. numbered item
• Links: [text](url)
• Code blocks: ```

code

- Tables: | col1 | col2 |
| --- | --- |
| data | data |
- Blockquotes: > quoted text
- Callouts: :::callout info
text
::: or :::callout warning
text
:::
- Diagrams: ```mermaid
graph TD;

Retrieve the article by its ID or URL from the database.

Retrieve a folder in a book with its ancestors and children (subfolders and articles). If folderUid is not provided, the root folder of the book will be retrieved. The articles in the result include only a name and UID. To get the full article body, call runbook-get-article.

Get current process information by book UID

List top 100 articles in a specified book with ID. The result does not include full article bodies as they are truncated to 200 characters. You will need to retrieve the full content by calling runbook-get-article.

Get a list of processes assigned to the current user

List top 100 books in the organization

List top 100 categories in a specified book with ID

This tool is used to start a new process or continue an existing one. If the run state UID is not provided, a new process will be created. Before executing run-process, you must call get-process and follow its instructions.

Search for articles using keywords from Runbook. The result does not include full article bodies as they are truncated to 200 characters. You will need to retrieve the full content by calling runbook-get-article

Update an existing article by its ID. The article body is in Markdown format. You can specify categories for the article by their IDs, which always start with 'ca_'. Markdown format supports:

• Headers: ## H2, ### H3, #### H4. Don't use # H1 as it is reserved for the article title.
• Bold: bold text
• Italic: _italic text_
• Lists: - item or 1. numbered item
• Links: [text](url)
• Code blocks: ```

code

- Tables: | col1 | col2 |
| --- | --- |
| data | data |
- Blockquotes: > quoted text
- Callouts: :::callout info
text
::: or :::callout warning
text
:::
- Diagrams: ```mermaid
graph TD;

Get a presigned URL to upload an attachment file for a running process. This tool does NOT upload the file itself. It returns an upload_url that you must use to upload the file contents via HTTP PUT (e.g., curl -X PUT --upload-file <path> "<upload_url>" or fetch(upload_url, { method: 'PUT', body: <content> })). Set the Content-Type header to match the content_type if provided. After uploading, pass the returned uid to run-process propertyValues as an array of UIDs.

Example:

article body

:::input file { uid="1:mgkxg1t4jq1sehs47s40xs70wr" required=true readOnly=false } Attachment files <input type="file" name="1:mgkxg1t4jq1sehs47s40xs70wr" /> :::

property values

{ "1:mgkxg1t4jq1sehs47s40xs70wr" : ["<FILE_UID>"] }