renamed to mcp-obsidian
This commit is contained in:
Markus Pfundstein
326
src/mcp_obsidian/tools.py
Normal file
326
src/mcp_obsidian/tools.py
Normal file
@@ -0,0 +1,326 @@
|
||||
from collections.abc import Sequence
|
||||
from mcp.types import (
|
||||
Tool,
|
||||
TextContent,
|
||||
ImageContent,
|
||||
EmbeddedResource,
|
||||
)
|
||||
import json
|
||||
import os
|
||||
from . import obsidian
|
||||
|
||||
api_key = os.getenv("OBSIDIAN_API_KEY", "")
|
||||
if api_key == "":
|
||||
raise ValueError("OBSIDIAN_API_KEY environment variable required")
|
||||
|
||||
TOOL_LIST_FILES_IN_VAULT = "list_files_in_vault"
|
||||
TOOL_LIST_FILES_IN_DIR = "list_files_in_dir"
|
||||
|
||||
class ToolHandler():
|
||||
def __init__(self, tool_name: str):
|
||||
self.name = tool_name
|
||||
|
||||
def get_tool_description(self) -> Tool:
|
||||
raise NotImplementedError()
|
||||
|
||||
def run_tool(self, args: dict) -> Sequence[TextContent | ImageContent | EmbeddedResource]:
|
||||
raise NotImplementedError()
|
||||
|
||||
class ListFilesInVaultToolHandler(ToolHandler):
|
||||
def __init__(self):
|
||||
super().__init__(TOOL_LIST_FILES_IN_VAULT)
|
||||
|
||||
def get_tool_description(self):
|
||||
return Tool(
|
||||
name=self.name,
|
||||
description="Lists all files and directories in the root directory of your Obsidian vault.",
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {},
|
||||
"required": []
|
||||
},
|
||||
)
|
||||
|
||||
def run_tool(self, args: dict) -> Sequence[TextContent | ImageContent | EmbeddedResource]:
|
||||
|
||||
api = obsidian.Obsidian(api_key=api_key)
|
||||
|
||||
files = api.list_files_in_vault()
|
||||
|
||||
return [
|
||||
TextContent(
|
||||
type="text",
|
||||
text=json.dumps(files, indent=2)
|
||||
)
|
||||
]
|
||||
|
||||
class ListFilesInDirToolHandler(ToolHandler):
|
||||
def __init__(self):
|
||||
super().__init__(TOOL_LIST_FILES_IN_DIR)
|
||||
|
||||
def get_tool_description(self):
|
||||
return Tool(
|
||||
name=self.name,
|
||||
description="Lists all files and directories that exist in a specific Obsidian directory.",
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"dirpath": {
|
||||
"type": "string",
|
||||
"description": "Path to list files from (relative to your vault root). Note that empty directories will not be returned."
|
||||
},
|
||||
},
|
||||
"required": ["dirpath"]
|
||||
}
|
||||
)
|
||||
|
||||
def run_tool(self, args: dict) -> Sequence[TextContent | ImageContent | EmbeddedResource]:
|
||||
|
||||
if "dirpath" not in args:
|
||||
raise RuntimeError("dirpath argument missing in arguments")
|
||||
|
||||
api = obsidian.Obsidian(api_key=api_key)
|
||||
|
||||
files = api.list_files_in_dir(args["dirpath"])
|
||||
|
||||
return [
|
||||
TextContent(
|
||||
type="text",
|
||||
text=json.dumps(files, indent=2)
|
||||
)
|
||||
]
|
||||
|
||||
class GetFileContentsToolHandler(ToolHandler):
|
||||
def __init__(self):
|
||||
super().__init__("get_file_contents")
|
||||
|
||||
def get_tool_description(self):
|
||||
return Tool(
|
||||
name=self.name,
|
||||
description="Return the content of a single file in your vault.",
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"filepath": {
|
||||
"type": "string",
|
||||
"description": "Path to the relevant file (relative to your vault root).",
|
||||
"format": "path"
|
||||
},
|
||||
},
|
||||
"required": ["filepath"]
|
||||
}
|
||||
)
|
||||
|
||||
def run_tool(self, args: dict) -> Sequence[TextContent | ImageContent | EmbeddedResource]:
|
||||
if "filepath" not in args:
|
||||
raise RuntimeError("filepath argument missing in arguments")
|
||||
|
||||
api = obsidian.Obsidian(api_key=api_key)
|
||||
|
||||
content = api.get_file_contents(args["filepath"])
|
||||
|
||||
return [
|
||||
TextContent(
|
||||
type="text",
|
||||
text=json.dumps(content, indent=2)
|
||||
)
|
||||
]
|
||||
|
||||
class SearchToolHandler(ToolHandler):
|
||||
def __init__(self):
|
||||
super().__init__("simple_search")
|
||||
|
||||
def get_tool_description(self):
|
||||
return Tool(
|
||||
name=self.name,
|
||||
description="""Simple search for documents matching a specified text query across all files in the vault.
|
||||
Use this tool when you want to do a simple text search""",
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"query": {
|
||||
"type": "string",
|
||||
"description": "Text to a simple search for in the vault."
|
||||
},
|
||||
"context_length": {
|
||||
"type": "integer",
|
||||
"description": "How much context to return around the matching string (default: 100)",
|
||||
"default": 100
|
||||
}
|
||||
},
|
||||
"required": ["query"]
|
||||
}
|
||||
)
|
||||
|
||||
def run_tool(self, args: dict) -> Sequence[TextContent | ImageContent | EmbeddedResource]:
|
||||
if "query" not in args:
|
||||
raise RuntimeError("query argument missing in arguments")
|
||||
|
||||
context_length = args.get("context_length", 100)
|
||||
|
||||
api = obsidian.Obsidian(api_key=api_key)
|
||||
results = api.search(args["query"], context_length)
|
||||
|
||||
formatted_results = []
|
||||
for result in results:
|
||||
formatted_matches = []
|
||||
for match in result.get('matches', []):
|
||||
context = match.get('context', '')
|
||||
match_pos = match.get('match', {})
|
||||
start = match_pos.get('start', 0)
|
||||
end = match_pos.get('end', 0)
|
||||
|
||||
formatted_matches.append({
|
||||
'context': context,
|
||||
'match_position': {'start': start, 'end': end}
|
||||
})
|
||||
|
||||
formatted_results.append({
|
||||
'filename': result.get('filename', ''),
|
||||
'score': result.get('score', 0),
|
||||
'matches': formatted_matches
|
||||
})
|
||||
|
||||
return [
|
||||
TextContent(
|
||||
type="text",
|
||||
text=json.dumps(formatted_results, indent=2)
|
||||
)
|
||||
]
|
||||
|
||||
class AppendContentToolHandler(ToolHandler):
|
||||
def __init__(self):
|
||||
super().__init__("append_content")
|
||||
|
||||
def get_tool_description(self):
|
||||
return Tool(
|
||||
name=self.name,
|
||||
description="Append content to a new or existing file in the vault.",
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"filepath": {
|
||||
"type": "string",
|
||||
"description": "Path to the file (relative to vault root)",
|
||||
"format": "path"
|
||||
},
|
||||
"content": {
|
||||
"type": "string",
|
||||
"description": "Content to append to the file"
|
||||
}
|
||||
},
|
||||
"required": ["filepath", "content"]
|
||||
}
|
||||
)
|
||||
|
||||
def run_tool(self, args: dict) -> Sequence[TextContent | ImageContent | EmbeddedResource]:
|
||||
if "filepath" not in args or "content" not in args:
|
||||
raise RuntimeError("filepath and content arguments required")
|
||||
|
||||
api = obsidian.Obsidian(api_key=api_key)
|
||||
api.append_content(args.get("filepath", ""), args["content"])
|
||||
|
||||
return [
|
||||
TextContent(
|
||||
type="text",
|
||||
text=f"Successfully appended content to {args['filepath']}"
|
||||
)
|
||||
]
|
||||
|
||||
class PatchContentToolHandler(ToolHandler):
|
||||
def __init__(self):
|
||||
super().__init__("patch_content")
|
||||
|
||||
def get_tool_description(self):
|
||||
return Tool(
|
||||
name=self.name,
|
||||
description="Insert content into an existing note relative to a heading, block reference, or frontmatter field.",
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"filepath": {
|
||||
"type": "string",
|
||||
"description": "Path to the file (relative to vault root)",
|
||||
"format": "path"
|
||||
},
|
||||
"operation": {
|
||||
"type": "string",
|
||||
"description": "Operation to perform (append, prepend, or replace)",
|
||||
"enum": ["append", "prepend", "replace"]
|
||||
},
|
||||
"target_type": {
|
||||
"type": "string",
|
||||
"description": "Type of target to patch",
|
||||
"enum": ["heading", "block", "frontmatter"]
|
||||
},
|
||||
"target": {
|
||||
"type": "string",
|
||||
"description": "Target identifier (heading path, block reference, or frontmatter field)"
|
||||
},
|
||||
"content": {
|
||||
"type": "string",
|
||||
"description": "Content to insert"
|
||||
}
|
||||
},
|
||||
"required": ["filepath", "operation", "target_type", "target", "content"]
|
||||
}
|
||||
)
|
||||
|
||||
def run_tool(self, args: dict) -> Sequence[TextContent | ImageContent | EmbeddedResource]:
|
||||
required = ["filepath", "operation", "target_type", "target", "content"]
|
||||
if not all(key in args for key in required):
|
||||
raise RuntimeError(f"Missing required arguments: {', '.join(required)}")
|
||||
|
||||
api = obsidian.Obsidian(api_key=api_key)
|
||||
api.patch_content(
|
||||
args.get("filepath", ""),
|
||||
args.get("operation", ""),
|
||||
args.get("target_type", ""),
|
||||
args.get("target", ""),
|
||||
args.get("content", "")
|
||||
)
|
||||
|
||||
return [
|
||||
TextContent(
|
||||
type="text",
|
||||
text=f"Successfully patched content in {args['filepath']}"
|
||||
)
|
||||
]
|
||||
|
||||
class ComplexSearchToolHandler(ToolHandler):
|
||||
def __init__(self):
|
||||
super().__init__("complex_search")
|
||||
|
||||
def get_tool_description(self):
|
||||
return Tool(
|
||||
name=self.name,
|
||||
description="""Complex search for documents using a JsonLogic query.
|
||||
Supports standard JsonLogic operators plus 'glob' and 'regexp' for pattern matching. Results must be non-falsy.
|
||||
|
||||
Use this tool when you want to do a complex search, e.g. for all documents with certain tags etc.
|
||||
""",
|
||||
inputSchema={
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"query": {
|
||||
"type": "object",
|
||||
"description": "JsonLogic query object. Example: {\"glob\": [\"*.md\", {\"var\": \"path\"}]} matches all markdown files"
|
||||
}
|
||||
},
|
||||
"required": ["query"]
|
||||
}
|
||||
)
|
||||
|
||||
def run_tool(self, args: dict) -> Sequence[TextContent | ImageContent | EmbeddedResource]:
|
||||
if "query" not in args:
|
||||
raise RuntimeError("query argument missing in arguments")
|
||||
|
||||
api = obsidian.Obsidian(api_key=api_key)
|
||||
results = api.search_json(args.get("query", ""))
|
||||
|
||||
return [
|
||||
TextContent(
|
||||
type="text",
|
||||
text=json.dumps(results, indent=2)
|
||||
)
|
||||
]
|
||||
Reference in New Issue
Block a user