feat(vscode): add language model tools for retrieving library documentation and environment details

Author: d-biehl

eslint.config.mjs

@@ -19,6 +19,7 @@ export default [
       "**/docs/",
       "**/packages/",
       "**/js",
+      "**/build/",
     ],
   },
   { files: ["**/*.{ts,tsx}"] },

package-lock.json

@@ -1940,6 +1940,66 @@
           }
         ]
       }
+    ],
+    "chatParticipants":[
+
+    ],
+    "languageModelTools": [
+      {
+        "name": "robot-get_library_doc",
+        "displayName": "Get Library Documentation",
+        "toolReferenceName": "robotGetLibraryDoc",
+        "modelDescription": "Gets the library documentation for the given library name. This includes keywords, documentation, and other information about the library.",
+        "userDescription": "Gets documentation for the given library.",
+        "canBeReferencedInPrompt": true,
+        "tags": [
+          "robot",
+          "robotframework",
+          "robotframework-library",
+          "robotframework-keyword",
+          "robotcode"
+        ],
+        "icon": "$(robotcode-robot)",
+        "inputSchema": {
+          "type": "object",
+          "required": [
+            "libraryName"
+          ],
+          "properties": {
+            "libraryName": {
+              "type": "string",
+              "description": "The name of the library."
+            },
+            "resourcePath": {
+              "type": "string",
+              "description": "The path to the robot framework file or workspace to get the library information for."
+            }
+          }
+        }
+      },
+      {
+        "name": "robot-get_environment_details",
+        "displayName": "Get Robot Framework Environment Informations",
+        "toolReferenceName": "robotGetEnvironmentInfo",
+        "modelDescription": "This tool will retrieve the details of the Robot Framework Environment for the specified file or workspace. This includes informations about the python interpreter, like the version and the executable path, and the versions of robot framework, RobotCode, robocop and robotidy if installed.",
+        "userDescription": "Gets informations about the Robot Framework Environment.",
+        "canBeReferencedInPrompt": true,
+        "tags": [
+          "robot",
+          "robotframework",
+          "robotcode"
+        ],
+        "icon": "$(robotcode-robot)",
+        "inputSchema": {
+          "type": "object",
+          "properties": {
+            "resourcePath": {
+              "type": "string",
+              "description": "The path to the robot framework file or workspace to get the details for."
+            }
+          }
+        }
+      }
     ]
   },
   "scripts": {
@@ -1961,7 +2021,8 @@
   "dependencies": {
     "ansi-colors": "^4.1.3",
     "fs-extra": "^11.3.0",
-    "vscode-languageclient": "^9.0.1"
+    "vscode-languageclient": "^9.0.1",
+    "@vscode/prompt-tsx": "^0.4.0-alpha.4"
   },
   "devDependencies": {
     "@eslint/compat": "^1.2.9",
@@ -1989,4 +2050,4 @@
   "workspaces": [
     "docs"
   ]
-}
+}

package.json

@@ -2,6 +2,7 @@
 from typing import TYPE_CHECKING, Any, List, Optional
 
 from robotcode.core.lsp.types import TextDocumentIdentifier
+from robotcode.core.uri import Uri
 from robotcode.core.utils.dataclasses import CamelSnakeMixin
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
@@ -18,6 +19,12 @@ class GetDocumentImportsParams(CamelSnakeMixin):
     text_document: TextDocumentIdentifier
 
 
+@dataclass(repr=False)
+class GetLibraryDocumentationParams(CamelSnakeMixin):
+    workspace_folder_uri: str
+    library_name: str
+
+
 @dataclass(repr=False)
 class Keyword(CamelSnakeMixin):
     name: str
@@ -26,6 +33,14 @@ class Keyword(CamelSnakeMixin):
     documentation: Optional[str] = None
 
 
+@dataclass(repr=False)
+class LibraryDocumentation(CamelSnakeMixin):
+    name: str
+    documentation: Optional[str] = None
+    keywords: Optional[List[Keyword]] = None
+    initializers: Optional[List[Keyword]] = None
+
+
 @dataclass(repr=False)
 class DocumentImport(CamelSnakeMixin):
     name: str
@@ -165,3 +180,43 @@ def _get_documentation_url(
             )
 
         return None
+
+    @rpc_method(
+        name="robot/keywordsview/getLibraryDocumentation", param_type=GetLibraryDocumentationParams, threaded=True
+    )
+    @_logger.call
+    def _get_library_documentation(
+        self,
+        workspace_folder_uri: str,
+        library_name: str,
+        *args: Any,
+        **kwargs: Any,
+    ) -> Optional[LibraryDocumentation]:
+        imports_manager = self.parent.documents_cache.get_imports_manager_for_uri(Uri(workspace_folder_uri))
+
+        libdoc = imports_manager.get_libdoc_for_library_import(library_name, (), ".")
+        if libdoc.errors:
+            raise ValueError(f"Errors while loading library documentation: {libdoc.errors}")
+
+        return LibraryDocumentation(
+            name=libdoc.name,
+            documentation=libdoc.to_markdown(),
+            keywords=[
+                Keyword(
+                    l.name,
+                    str(hash(l)),
+                    l.parameter_signature(),
+                    l.to_markdown(),
+                )
+                for l in libdoc.keywords.values()
+            ],
+            initializers=[
+                Keyword(
+                    s.name,
+                    str(hash(s)),
+                    s.parameter_signature(),
+                    s.to_markdown(),
+                )
+                for s in libdoc.inits.values()
+            ],
+        )

packages/language_server/src/robotcode/language_server/robotframework/parts/keywords_treeview.py

@@ -1,3 +1,4 @@
+import sys
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Any, Optional
 
@@ -7,6 +8,7 @@
 from robotcode.core.utils.logging import LoggingDescriptor
 from robotcode.jsonrpc2.protocol import rpc_method
 
+from ...__version__ import __version__ as robotcode_version
 from .protocol_part import RobotLanguageServerProtocolPart
 from .robocop_tidy_mixin import RoboCopTidyMixin
 
@@ -19,6 +21,9 @@ class ProjectInfo(CamelSnakeMixin):
     robot_version_string: str
     robocop_version_string: Optional[str]
     tidy_version_string: Optional[str] = None
+    python_version_string: Optional[str] = None
+    python_executable: Optional[str] = None
+    robot_code_version_string: Optional[str] = None
 
 
 class ProjectInfoPart(RobotLanguageServerProtocolPart, RoboCopTidyMixin):
@@ -46,4 +51,7 @@ def _robot_project_info(
             robot_version_string=get_version(),
             robocop_version_string=robocop_version_string,
             tidy_version_string=tidy_version_string,
+            python_version_string=sys.version,
+            python_executable=sys.executable,
+            robot_code_version_string=robotcode_version,
         )

packages/language_server/src/robotcode/language_server/robotframework/parts/project_info.py

@@ -7,6 +7,7 @@ import { KeywordsTreeViewProvider } from "./keywordsTreeViewProvider";
 import { LanguageToolsManager } from "./languageToolsManager";
 import { NotebookManager } from "./notebook";
 import path from "path";
+import { GetEnvironmentDetails, GetLibDocTool } from "./lmTools";
 
 class TerminalLink extends vscode.TerminalLink {
   constructor(
@@ -153,6 +154,11 @@ export async function activateAsync(context: vscode.ExtensionContext): Promise<v
         }, 1000);
       }
     }),
+    vscode.lm.registerTool("robot-get_library_doc", new GetLibDocTool(context, languageClientManger, outputChannel)),
+    vscode.lm.registerTool(
+      "robot-get_environment_details",
+      new GetEnvironmentDetails(context, languageClientManger, outputChannel),
+    ),
   );
 
   const collection = context.environmentVariableCollection;

vscode-client/extension/index.ts

@@ -43,6 +43,13 @@ export interface Keyword {
   documentation?: string;
 }
 
+export interface LibraryDocumentation {
+  name: string;
+  documentation?: string;
+  keywords?: Keyword[];
+  initializers?: DocumentImport[];
+}
+
 export interface DocumentImport {
   name: string;
   alias?: string;
@@ -106,6 +113,9 @@ export interface ProjectInfo {
   robotVersionString?: string;
   robocopVersionString?: string;
   tidyVersionString?: string;
+  pythonVersionString?: string;
+  pythonExecutable?: string;
+  robotCodeVersionString?: string;
 }
 
 interface RobotCodeContributions {
@@ -900,6 +910,27 @@ export class LanguageClientsManager {
     );
   }
 
+  public async getLibraryDocumentation(
+    workspace_folder: vscode.WorkspaceFolder,
+    libraryName: string,
+    token?: vscode.CancellationToken | undefined,
+  ): Promise<LibraryDocumentation | undefined> {
+    const client = await this.getLanguageClientForResource(workspace_folder.uri);
+
+    if (!client) return undefined;
+
+    return (
+      (await client.sendRequest<LibraryDocumentation>(
+        "robot/keywordsview/getLibraryDocumentation",
+        {
+          workspaceFolderUri: workspace_folder.uri.toString(),
+          libraryName: libraryName,
+        },
+        token ?? new vscode.CancellationTokenSource().token,
+      )) ?? undefined
+    );
+  }
+
   public async getDocumentKeywords(
     document: vscode.TextDocument,
     token?: vscode.CancellationToken | undefined,