Runbook

- get-article

- Retrieve the article by its ID from the database.
- Required inputs:

- articleUid(string): ID of the article to retrieve. It always starts withar_.

- 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 callingget-article.
- Required inputs:

- bookUid(string): ID of the book. It always starts with 'bk_'. You can retrieve a list of books with list-books.

- articleName(string): If provided, the result will be filtered by article name.
- categoryUid(string): ID of the category. It always starts with 'ca_'. You can retrieve a list of categories with list-categories.
- orderBy(string): Sort field (updatedAt, createdAt, 'name', or 'popularity').

- 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 list-books and categories with list-categories.
- Required inputs:

- bookUid(string): ID of the book. It always starts with 'bk_'. You can retrieve a list of books with list-books.
- name(string): Name of the article to create.

- bodyMarkdown(string): Body of the article in Markdown format. If not provided, an empty article will be created.
- categoryUids(array): IDs of the categories to assign to the article. Each ID starts with 'ca_'. You can retrieve a list of categories with list-categories.

- 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_'.
- Required inputs:

- articleUid(string): ID of the article to update. It always starts withar_. You can retrieve a list of articles with list-articles.

- name(string): Name of the article to update.
- bodyMarkdown(string): Body of the article in Markdown format. If not provided, the body will not be updated.
- categoryUids(array): IDs of the categories to assign to the article. Each ID starts with 'ca_'. You can retrieve a list of categories with list-categories.

- List top 100 books in the organization.
- Optional inputs:

- bookName(string): If provided, the result will be filtered by book name.

- List top 100 categories in a specified book with ID.
- Required inputs:

- bookUid(string): ID of the book. It always starts with 'bk_'. You can retrieve a list of books with list-books.

- Retrieve a folder in a book with its ancestors and children (subfolders and articles). IffolderUidis 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 get-article.
- Required inputs:

- bookUid(string): ID of the book. It always starts with 'bk_'. You can retrieve a list of books with list-books.

- folderUid(string): ID of the folder. It always starts with 'fo_'. If not provided, the root folder of the book will be used.

- 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 get-article.
- Required inputs:

- keywords(string): Space-separated keywords to filter articles. If multiple keywords are provided, the articles that match all of them will be returned. Use current language for keywords.

- scope(string): ID of the book or workspace. If provided, the result will be filtered by them. Default: all.
- limit(number): Number of articles to retrieve.
- offset(number): Offset of the search result.
- orderBy(string): Sort field (updatedAt, createdAt, or 'score'). Default: score.

- Get a list of in-progress processes (workflow run states) assigned to the current user that are not yet processed. Returns up to 20 results, each including the run state UID (starts with 'rs_'), status, creation date, and the book it belongs to. Use the returnedbook.uidand run stateuidwithget-processto read the process details.
- No inputs.

- Get current process information by book UID.
- Required inputs:

- bookUid(string): ID of the book. It always starts with 'bk_'. The book type must be 'workflow'.

- runStateUid(string): ID of the run state. It always starts with 'rs_'. If not provided, the first run state will be used.

- 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.
- Required inputs:

- bookUid(string): ID of the book. It always starts with 'bk_'. The book type must be 'workflow'.
- articleUid(string): ID of the article. It always starts with 'ar_'. The article UID is included in the return value of get-process and run-process.

Alternatively, add the following to your claude_desktop_config.json: