Merge branch 'main' into validate-input-schema

Author: mhmd-azeez

servlets/obsidian/.gitignore

@@ -0,0 +1,2 @@
+plugin.wasm
+plugin/__pycache__

servlets/obsidian/plugin/__init__.py

@@ -2,9 +2,10 @@
 
 from typing import Optional, List  # noqa: F401
 from datetime import datetime  # noqa: F401
+import json
 import extism  # pyright: ignore
 import plugin
-import json
+
 
 from pdk_types import (
     BlobResourceContents,
@@ -23,6 +24,7 @@
 
 # Imports
 
+
 # Exports
 # The implementations for these functions is in `plugin.py`
 
@@ -31,9 +33,10 @@
 # If you support multiple tools, you must switch on the input.params.name to detect which tool is being called.
 @extism.plugin_fn
 def call():
-    data = json.loads(extism.input_str())
-    res = plugin.call(data)
-    extism.output(res)
+    input = extism.input_str()
+    input = CallToolRequest.from_json(input)
+    res = plugin.call(input)
+    extism.output_str(res.to_json())
 
 
 # Called by mcpx to understand how and why to use this tool.
@@ -42,4 +45,4 @@ def call():
 @extism.plugin_fn
 def describe():
     res = plugin.describe()
-    extism.output(res)
+    extism.output_str(res.to_json())

servlets/obsidian/plugin/pdk_imports.py

@@ -3,6 +3,7 @@
 from typing import Optional, List  # noqa: F401
 from datetime import datetime  # noqa: F401
 import extism  # noqa: F401 # pyright: ignore
+import json
 
 
 from pdk_types import (

servlets/obsidian/plugin/pdk_types.py

@@ -5,53 +5,82 @@
 from typing import Optional, List  # noqa: F401
 from datetime import datetime  # noqa: F401
 from dataclasses import dataclass  # noqa: F401
-
-import extism  # noqa: F401 # pyright: ignore
+from dataclass_wizard import JSONWizard, skip_if_field, IS  # noqa: F401
+from dataclass_wizard.type_def import JSONObject
+from base64 import b64encode, b64decode
 
 
 @dataclass
-class BlobResourceContents(extism.Json):
+class BlobResourceContents(JSONWizard):
     # A base64-encoded string representing the binary data of the item.
     blob: str
 
-    # The MIME type of this resource, if known.
-    mimeType: str
-
     # The URI of this resource.
     uri: str
 
+    # The MIME type of this resource, if known.
+    mimeType: Optional[str] = skip_if_field(IS(None), default=None)
 
-@dataclass
-class CallToolRequest(extism.Json):
-    method: str
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
 
+    def _pre_dict(self):
+        return
+
+
+@dataclass
+class CallToolRequest(JSONWizard):
     params: Params
 
+    method: Optional[str] = skip_if_field(IS(None), default=None)
+
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
+
+    def _pre_dict(self):
+        return
+
 
 @dataclass
-class CallToolResult(extism.Json):
+class CallToolResult(JSONWizard):
     content: List[Content]
 
     # Whether the tool call ended in an error.
     #
     # If not set, this is assumed to be false (the call was successful).
-    isError: bool
+    isError: Optional[bool] = skip_if_field(IS(None), default=None)
+
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
+
+    def _pre_dict(self):
+        return
 
 
 @dataclass
-class Content(extism.Json):
-    annotations: TextAnnotation
+class Content(JSONWizard):
+    type: ContentType
+
+    annotations: Optional[TextAnnotation] = skip_if_field(IS(None), default=None)
 
     # The base64-encoded image data.
-    data: str
+    data: Optional[str] = skip_if_field(IS(None), default=None)
 
     # The MIME type of the image. Different providers may support different image types.
-    mimeType: str
+    mimeType: Optional[str] = skip_if_field(IS(None), default=None)
 
     # The text content of the message.
-    text: str
+    text: Optional[str] = skip_if_field(IS(None), default=None)
 
-    type: ContentType
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
+
+    def _pre_dict(self):
+        return
 
 
 class ContentType(Enum):
@@ -61,52 +90,80 @@ class ContentType(Enum):
 
 
 @dataclass
-class ListToolsResult(extism.Json):
+class ListToolsResult(JSONWizard):
     # The list of ToolDescription objects provided by this servlet.
     tools: List[ToolDescription]
 
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
+
+    def _pre_dict(self):
+        return
 
-@dataclass
-class Params(extism.Json):
-    arguments: dict
 
+@dataclass
+class Params(JSONWizard):
     name: str
 
+    arguments: Optional[dict] = skip_if_field(IS(None), default=None)
+
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
+
+    def _pre_dict(self):
+        return
+
 
 class Role(Enum):
     Assistant = "assistant"
     User = "user"
 
 
 @dataclass
-class TextAnnotation(extism.Json):
+class TextAnnotation(JSONWizard):
     # Describes who the intended customer of this object or data is.
     #
     # It can include multiple entries to indicate content useful for multiple audiences (e.g., `["user", "assistant"]`).
-    audience: List[Role]
+    audience: Optional[List[Role]] = skip_if_field(IS(None), default=None)
 
     # Describes how important this data is for operating the server.
     #
     # A value of 1 means "most important," and indicates that the data is
     # effectively required, while 0 means "least important," and indicates that
     # the data is entirely optional.
-    priority: float
+    priority: Optional[float] = skip_if_field(IS(None), default=None)
 
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
 
-@dataclass
-class TextResourceContents(extism.Json):
-    # The MIME type of this resource, if known.
-    mimeType: str
+    def _pre_dict(self):
+        return
 
+
+@dataclass
+class TextResourceContents(JSONWizard):
     # The text of the item. This must only be set if the item can actually be represented as text (not binary data).
     text: str
 
     # The URI of this resource.
     uri: str
 
+    # The MIME type of this resource, if known.
+    mimeType: Optional[str] = skip_if_field(IS(None), default=None)
+
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
+
+    def _pre_dict(self):
+        return
+
 
 @dataclass
-class ToolDescription(extism.Json):
+class ToolDescription(JSONWizard):
     # A description of the tool
     description: str
 
@@ -115,3 +172,10 @@ class ToolDescription(extism.Json):
 
     # The name of the tool. It should match the plugin / binding name.
     name: str
+
+    @classmethod
+    def _pre_from_dict(cls, o: JSONObject) -> JSONObject:
+        return o
+
+    def _pre_dict(self):
+        return

servlets/obsidian/plugin/plugin.py

@@ -2,6 +2,8 @@
 from datetime import datetime  # noqa: F401
 import extism  # noqa: F401 # pyright: ignore
 from urllib.parse import urlencode
+import urllib.parse
+import json
 
 from pdk_types import (
     BlobResourceContents,
@@ -63,7 +65,7 @@ def search(self, query: str, context_length: int = 100):
     def append_content(self, path, content):
         return self.post(f"/vault/{path}", content, {'Content-Type': 'text/markdown'})
 
-    def patch_content(filepath, operation, target_type, target, content):
+    def patch_content(self, path, operation, target_type, target, content):
         headers = {
             'Content-Type': 'text/markdown',
             'Operation': operation,
@@ -76,7 +78,6 @@ def complex_search(self, query):
         headers = {
             'Content-Type': 'application/vnd.olrapi.jsonlogic+json',
         }
-        query_string = urlencode(params)
         return self.post(f"/search/", json.dumps(query), headers)
 
 def errorReturn(message):
@@ -93,60 +94,56 @@ def errorReturn(message):
                 isError=True,
             )
 
-
 # Called when the tool is invoked.
 # If you support multiple tools, you must switch on the input.params.name to detect which tool is being called.
-def call(input) -> CallToolResult:
-    try:
-        fname = input['params']['name']
-    except:
-        raise Exception("params name must be provided")
+def call(input: CallToolRequest) -> CallToolResult:
+    fname = input.params.name
     obsidian = Obsidian()
     match fname:
         case "list_files_in_vault":
             contentText = obsidian.list_files_in_vault()
         case "list_files_in_dir":
             try:
-                dirpath = input['params']['arguments']['dirpath']
-            except:
+                dirpath = input.params.arguments['dirpath']
+                contentText = obsidian.list_files_in_dir(dirpath)
+            except (KeyError, TypeError):
                 return errorReturn("Argument dirpath not provided")
-            contentText = obsidian.list_files_in_dir(dirpath)
         case "get_file_contents":
             try:
-                filepath = input['params']['arguments']['filepath']
-            except:
+                filepath = input.params.arguments['filepath']
+                contentText = obsidian.get_file_contents(filepath)
+            except (KeyError, TypeError):
                 return errorReturn("Argument filepath not provided")
-            contentText = obsidian.get_file_contents(filepath)
         case "simple_search":
             try:
-                query = input['params']['arguments']['query']
-            except:
+                query = input.params.arguments['query']
+                context_length = input.params.arguments.get('context_length')
+                contentText = obsidian.search(query, context_length)
+            except (KeyError, TypeError):
                 return errorReturn("Argument query not provided")
-            context_length = input['params']['arguments'].get('context_length')
-            contentText = obsidian.search(query, context_length)
         case "append_content":
             try:
-                filepath = input['params']['arguments']['filepath']
-                content = input['params']['arguments']['content']
-            except:
+                filepath = input.params.arguments['filepath']
+                content = input.params.arguments['content']
+                contentText = obsidian.append_content(filepath, content)
+            except (KeyError, TypeError):
                 return errorReturn("Argument filepath or content not provided")
-            contentText = obsidian.append_content(filepath, content)
         case "patch_content":
             try:
-                filepath = input['params']['arguments']['filepath']
-                operation = input['params']['arguments']['operation']
-                target_type = input['params']['arguments']['target_type']
-                target = input['params']['arguments']['target']
-                content = input['params']['arguments']['content']
-            except:
+                filepath = input.params.arguments['filepath']
+                operation = input.params.arguments['operation']
+                target_type = input.params.arguments['target_type']
+                target = input.params.arguments['target']
+                content = input.params.arguments['content']
+                contentText = obsidian.patch_content(filepath, operation, target_type, target, content)
+            except (KeyError, TypeError):
                 return errorReturn("Arguments missing")
-            contentText = obsidian.patch_content(filepath, operation, target_type, target, content)
         case "complex_search":
             try:
-                query = input['params']['arguments']['query']
-            except:
+                query = input.params.arguments['query']
+                contentText = obsidian.complex_search(query)
+            except (KeyError, TypeError):
                 return errorReturn("Argument query not provided")
-            contentText = obsidian.complex_search(query)
         case _:
             return errorReturn(f"Unknown tool {fname}")
     return CallToolResult(
@@ -159,7 +156,6 @@ def call(input) -> CallToolResult:
                 data=None,
             )
         ],
-        isError=False,
     )
 
 

servlets/obsidian/prepare.sh

@@ -40,5 +40,3 @@ if ! command_exists extism-py; then
   sleep 2
   exit 1
 fi
-
-

servlets/obsidian/pyproject.toml

@@ -3,8 +3,10 @@ name = "obsidian"
 version = "0.1.0"
 description = "Add your description here"
 readme = "README.md"
-requires-python = ">=3.12"
-dependencies = []
+requires-python = ">=3.13,<3.14"
+dependencies = [
+    "dataclass-wizard>=0.33.0,<0.34.0"
+]
 
 [tool.uv]
 dev-dependencies = [