Save 4 hours! We auto-setup your workflow! Free!

Drop your workflow.json — we handle every dependency, custom node, and model. Just open the link and run.

Auto-Setup Workflow Json (Free) Now!
ComfyUI > Nodes > OpenKatana > OpenKatana · Read guide

ComfyUI Node: OpenKatana · Read guide

Class Name

OpenKatana_read_guide

Category
OpenKatana/Tools
Author
rk0neki (Account age: 235days)
Extension
OpenKatana
Latest Updated
2026-11-05
Github Stars
0.05K

How to Install OpenKatana

Install this extension via the ComfyUI Manager by searching for OpenKatana
  • 1. Click the Manager button in the main menu
  • 2. Select Custom Nodes Manager button
  • 3. Enter OpenKatana in the search bar
After installation, click the Restart button to restart ComfyUI. Then, manually refresh your browser to clear the cache and access the updated list of nodes.

Visit ComfyUI Online for ready-to-use ComfyUI environment

  • Free trial available
  • 16GB VRAM to 80GB VRAM GPU machines
  • 400+ preloaded models/nodes
  • Freedom to upload custom models/nodes
  • 200+ ready-to-run workflows
  • 100% private workspace with up to 200GB storage
  • Dedicated Support

Run ComfyUI Online

OpenKatana · Read guide Description

Retrieves topic-based OpenKatana guides in Markdown for editing and AI-assisted workflows.

OpenKatana · Read guide:

OpenKatana_read_guide retrieves OpenKatana’s topic-based guide material so you can consult instructions while building an editing or AI-assisted creative workflow. It provides access to documentation rather than performing media analysis, generating images, or editing a timeline. The supplied integration shows that guide content is available as Markdown, a plain-text format that can include headings, lists, and examples. This makes the node useful for checking how an OpenKatana feature works before using other tools, reducing guesswork and helping you choose a documented approach. The available topics and the full contents of the guides are not included in the supplied source.

OpenKatana · Read guide Input Parameters:

project_id

A required STRING passed to the shared OpenKatana argument-preparation layer before the guide request is invoked. This is the project-context field used by the node wrapper; however, the supplied guide-resource example calls the guide API using only a topic, so the provided code does not establish whether reading a guide actually requires a valid project or how this field is handled for this particular tool. Use the project identifier associated with your OpenKatana workflow when available, rather than treating this field as the guide topic. No default value, list of allowed values, or minimum or maximum string length is shown in the supplied interface.

arguments

A required STRING containing the tool arguments that the wrapper prepares for the guide request. The supplied integration demonstrates that the guide API accepts a topic argument, so this is the field in which to supply that request information using the argument format expected by the shared wrapper. For example, a JSON-formatted request would be {"topic":"YOUR_DOCUMENTED_TOPIC"}, with the placeholder replaced by a topic supported by your installation. This does not mean that topic is a separate node input; it belongs inside the argument data. The shared argument-parsing implementation and the complete guide signature are not included, so additional supported keys, parsing behavior, and topic choices cannot be confirmed. No default value or minimum or maximum string length is shown.

after

An optional STRING accepted by the node’s execution method, with a method-level default of None when omitted. In the supplied implementation, this value is not referenced when preparing arguments or invoking the tool, so it does not directly select a guide or change the guide request. It may serve as a connection point in the surrounding workflow, but any broader scheduling behavior is not established by the provided code. Leave it unconnected when you do not need that connection. No allowed-value list or minimum or maximum string length is shown.

OpenKatana · Read guide Output Parameters:

result_json

The node’s single STRING output contains the response produced by the shared response wrapper after the guide tool is invoked. Treat it as the serialized tool response rather than assuming that it is only the guide’s plain text. The supplied server integration accesses a markdown field in the guide API’s response, confirming that Markdown guide content is part of that API result; however, the node’s response-wrapper implementation is not provided, so the exact outer JSON structure and any additional fields cannot be confirmed. Inspect the returned text before connecting it to a JSON parser or another processing node. A successful guide response supplies reference material for you or a downstream assistant to read; it is not a rendered image, video, or edited project.

OpenKatana · Read guide Usage Tips:

  • Choose a topic documented by your installed version of OpenKatana. The supplied context does not list available topics, so avoid inventing topic names based on unrelated tools or feature names.
  • Keep the request focused on the guide topic. The supplied guide-resource example demonstrates a topic argument, but does not demonstrate analysis settings, rendering options, or media paths for this tool.
  • When supplying JSON-formatted arguments, use double quotation marks around property names and text values, and avoid trailing commas. Replace YOUR_DOCUMENTED_TOPIC in {"topic":"YOUR_DOCUMENTED_TOPIC"} with an actual supported topic.
  • Inspect result_json in a text-display or inspection node before building downstream extraction steps. Confirm where the guide content appears rather than assuming the output is raw Markdown or that the response has a particular nesting structure.
  • Use this node to consult instructions before configuring tools that modify projects or process media. Reading a guide is a documentation task; it does not itself run the operations described in the guide.
  • Leave after unconnected for a standalone guide lookup. If you connect it within a larger workflow, do not expect its text value to change the selected guide, because the shown execution method does not use it in the tool arguments.

OpenKatana · Read guide Common Errors and Solutions:

unexpected inputs: …

  • Explanation: This is the explicit error-message pattern in the supplied node class. The wrapper raises a TypeError if execution receives extra named fields that are not among its declared typed inputs. This can happen with an outdated workflow or a custom integration that sends a guide argument as an additional node field.
  • Solution: Use only the exposed inputs: project_id, arguments, and optional after. Place the guide request information inside arguments rather than adding a separate topic input. Refresh the node definition if a saved workflow contains obsolete fields.

Missing required input: project_id or arguments

  • Explanation: This is a diagnostic description, not a confirmed literal error string. Both fields are required by the node interface, even though the supplied guide-resource example does not demonstrate a project requirement at the underlying guide-API level.
  • Solution: Supply both required STRING inputs. Use your workflow’s project identifier for project_id and the guide request data for arguments. Do not assume that the node will fill in either value automatically.

Arguments cannot be parsed

  • Explanation: This is a possible argument-preparation failure; the exact parser error is not included in the supplied source. If the shared wrapper expects JSON, incomplete objects, mismatched quotation marks, or trailing commas can prevent the request from reaching the guide tool.
  • Solution: Check the argument format required by your installation. For a JSON-formatted request, use a complete object such as {"topic":"YOUR_DOCUMENTED_TOPIC"} and replace the placeholder with a supported topic.

Missing or unsupported guide topic

  • Explanation: This is a possible guide-request failure, not a verified literal error message. The supplied integration passes a topic to read_guide, but does not show the supported topic names or the behavior for an unrecognized topic.
  • Solution: Verify the exact topic name in your installed OpenKatana documentation or tool metadata. Check spelling and supply the topic in the argument data; changing project_id or after will not substitute for selecting a topic.

Unknown argument rejected

  • Explanation: The supplied server configuration explicitly forbids unknown arguments for tools registered through that server. If the request uses that route, extra keys can cause validation failure rather than being silently ignored. The exact validation message depends on the integration.
  • Solution: Remove keys that are not supported by the installed read_guide tool signature. Start with the demonstrated topic argument and add other keys only when the tool documentation explicitly permits them.

Downstream processing cannot find the guide text

  • Explanation: A later node may fail if it treats result_json as raw Markdown or expects a JSON layout that differs from the actual response. The supplied code confirms a markdown field in the guide API result, but does not reveal the complete node-output envelope.
  • Solution: Display the returned string first. If it is JSON, parse it and locate the guide content in the observed structure, then configure downstream extraction using that actual path.

OpenKatana · Read guide Related Nodes

Go back to the extension to check out more related nodes.
OpenKatana
RunComfy
Copyright 2025 RunComfy. All Rights Reserved.

RunComfy is the premier ComfyUI platform, offering ComfyUI online environment and services, along with ComfyUI workflows featuring stunning visuals. RunComfy also provides AI Models, enabling artists to harness the latest AI tools to create incredible art.

OpenKatana · Read guide