get_keyword_info
Retrieve documentation for Robot Framework keywords or libraries, and parse keyword signatures to identify required arguments.
Instructions
Get keyword/library docs or parse a signature. Call this before execute_step when you know the keyword name but not its arguments.
Modes: "keyword" (default — document one keyword), "library" (list a library's keywords), "session" (resolve against the live session namespace), "parse" (parse a signature string). Pass session_id to scope the lookup to that session's libraries.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | One of "keyword" (default), "library", "session", or "parse". | keyword |
| arguments | No | Optional arguments to parse when mode="parse". | |
| session_id | No | Optional session id. - mode="keyword" / "global" (OBS-19): when provided without ``library_name``, restricts the keyword lookup to libraries imported in that session (plus neutral helpers like BuiltIn, Collections). When the keyword exists only in other libraries, the response carries a library-mismatch error + plugin-generated alternative hint instead of the keyword doc. Sessions without ``session_id`` get the global lookup (cross-library matches[]). - mode="session" / "namespace": required to address the live RF namespace. - **Externalisation gate (OBS-21)**: any mode with ``session_id`` provided enables artifact externalisation for large payloads (``library.doc``, ``library.keywords``, ``keyword.doc``, ``matches``). Without ``session_id``, payloads stay inline regardless of size — there's no artifact store to write to, so sessionless callers get the full content. Preserves backwards compat. | |
| keyword_name | No | Keyword to document (required for modes "keyword"/"session"/"parse"). | |
| library_name | No | Library to document (required for mode "library"; optional for keyword mode — explicit per-call scope that takes precedence over session-derived scope). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||