obsidian-mcp-server 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/README.md CHANGED
@@ -2,14 +2,14 @@
2
2
 
3
3
  [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org/)
4
4
  [![Model Context Protocol](https://img.shields.io/badge/MCP-1.4.0-green.svg)](https://modelcontextprotocol.io/)
5
- [![Version](https://img.shields.io/badge/Version-1.1.0-blue.svg)]()
5
+ [![Version](https://img.shields.io/badge/Version-1.2.0-blue.svg)]()
6
6
  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
7
7
  [![Status](https://img.shields.io/badge/Status-Stable-blue.svg)]()
8
8
  [![GitHub](https://img.shields.io/github/stars/cyanheads/obsidian-mcp-server?style=social)](https://github.com/cyanheads/obsidian-mcp-server)
9
9
 
10
10
  A Model Context Protocol server designed for LLMs to interact with Obsidian vaults. Built with TypeScript and featuring secure API communication, efficient file operations, and comprehensive search capabilities, it enables AI assistants to seamlessly manage knowledge bases through a clean, flexible tool interface.
11
11
 
12
- The Model Context Protocol (MCP) enables AI models to interact with external tools and resources through a standardized interface. This server implements MCP to provide LLMs with secure, token-aware access to Obsidian vaults.
12
+ The Model Context Protocol (MCP) enables AI models to interact with external tools and resources through a standardized interface.
13
13
 
14
14
  Requires the Local REST API plugin in Obsidian.
15
15
 
@@ -25,6 +25,12 @@ Requires the Local REST API plugin in Obsidian.
25
25
  - Configurable context boundaries and token limits
26
26
  - Optimized query processing
27
27
 
28
+ ### Property Management
29
+ - YAML frontmatter parsing and validation
30
+ - Intelligent property merging and updates
31
+ - Automatic timestamp management
32
+ - Custom field support
33
+
28
34
  ### Security & Performance
29
35
  - API key authentication and rate limiting
30
36
  - SSL verification options
@@ -120,6 +126,38 @@ obsidian_patch_content: {
120
126
  }
121
127
  ```
122
128
 
129
+ ### Property Management
130
+ ```typescript
131
+ // Get note properties
132
+ obsidian_get_properties: {
133
+ filepath: string // Path relative to vault root
134
+ }
135
+
136
+ // Update note properties
137
+ obsidian_update_properties: {
138
+ filepath: string, // Path relative to vault root
139
+ properties: {
140
+ title?: string,
141
+ created?: string, // ISO date
142
+ modified?: string, // ISO date (auto-updated)
143
+ author?: string,
144
+ type?: Array<"concept" | "architecture" | "specification" |
145
+ "protocol" | "api" | "research" | "implementation" |
146
+ "guide" | "reference">,
147
+ tags?: string[], // Must start with #
148
+ status?: Array<"draft" | "in-progress" | "review" | "complete">,
149
+ version?: string,
150
+ platform?: string,
151
+ repository?: string, // URL
152
+ dependencies?: string[],
153
+ sources?: string[],
154
+ urls?: string[], // URLs
155
+ papers?: string[],
156
+ custom?: Record<string, unknown>
157
+ }
158
+ }
159
+ ```
160
+
123
161
  ## Best Practices
124
162
 
125
163
  ### File Operations
@@ -134,6 +172,12 @@ obsidian_patch_content: {
134
172
  - Handle large result sets
135
173
  - Consider token limits
136
174
 
175
+ ### Property Management
176
+ - Validate property values before updates
177
+ - Use appropriate property types
178
+ - Handle array merging appropriately
179
+ - Consider custom field implications
180
+
137
181
  ### Error Prevention
138
182
  - Validate inputs thoroughly
139
183
  - Handle API errors gracefully
@@ -0,0 +1,156 @@
1
+ import { parse, stringify } from 'yaml';
2
+ import { ObsidianPropertiesSchema } from './propertyTypes.js';
3
+ export class PropertyManager {
4
+ client;
5
+ constructor(client) {
6
+ this.client = client;
7
+ }
8
+ /**
9
+ * Parse YAML frontmatter from note content
10
+ */
11
+ parseProperties(content) {
12
+ try {
13
+ // Extract frontmatter between --- markers
14
+ const match = content.match(/^---\n([\s\S]*?)\n---/);
15
+ if (!match) {
16
+ return {};
17
+ }
18
+ const frontmatter = match[1];
19
+ const properties = parse(frontmatter);
20
+ // Validate against schema
21
+ const result = ObsidianPropertiesSchema.safeParse(properties);
22
+ if (!result.success) {
23
+ console.warn('Property validation warnings:', result.error);
24
+ // Return partial valid properties rather than throwing
25
+ return properties;
26
+ }
27
+ return result.data;
28
+ }
29
+ catch (error) {
30
+ console.error('Error parsing properties:', error);
31
+ return {};
32
+ }
33
+ }
34
+ /**
35
+ * Generate YAML frontmatter from properties
36
+ */
37
+ generateProperties(properties) {
38
+ try {
39
+ // Remove undefined values
40
+ const cleanProperties = Object.fromEntries(Object.entries(properties).filter(([_, v]) => v !== undefined));
41
+ // Generate YAML
42
+ const yaml = stringify(cleanProperties);
43
+ return `---\n${yaml}---\n`;
44
+ }
45
+ catch (error) {
46
+ console.error('Error generating properties:', error);
47
+ throw error;
48
+ }
49
+ }
50
+ /**
51
+ * Validate property values
52
+ */
53
+ validateProperties(properties) {
54
+ const result = ObsidianPropertiesSchema.safeParse(properties);
55
+ if (result.success) {
56
+ return { valid: true, errors: [] };
57
+ }
58
+ return {
59
+ valid: false,
60
+ errors: result.error.errors.map(err => `${err.path.join('.')}: ${err.message}`)
61
+ };
62
+ }
63
+ /**
64
+ * Merge new properties with existing ones
65
+ */
66
+ mergeProperties(existing, updates) {
67
+ const merged = { ...existing };
68
+ for (const [key, value] of Object.entries(updates)) {
69
+ if (value === undefined)
70
+ continue;
71
+ const currentValue = merged[key];
72
+ // Special handling for arrays - merge rather than replace
73
+ if (Array.isArray(value) && Array.isArray(currentValue)) {
74
+ merged[key] = [
75
+ ...new Set([...currentValue, ...value])
76
+ ];
77
+ }
78
+ // Special handling for custom object - deep merge
79
+ else if (key === 'custom' && typeof value === 'object' && value !== null) {
80
+ merged.custom = {
81
+ ...merged.custom,
82
+ ...value
83
+ };
84
+ }
85
+ // Default case - replace value
86
+ else {
87
+ merged[key] = value;
88
+ }
89
+ }
90
+ // Always update modified date
91
+ merged.modified = new Date().toISOString();
92
+ return merged;
93
+ }
94
+ /**
95
+ * Get properties from a note
96
+ */
97
+ async getProperties(filepath) {
98
+ try {
99
+ const content = await this.client.getFileContents(filepath);
100
+ const properties = this.parseProperties(content);
101
+ return {
102
+ success: true,
103
+ message: 'Properties retrieved successfully',
104
+ properties
105
+ };
106
+ }
107
+ catch (error) {
108
+ return {
109
+ success: false,
110
+ message: `Failed to get properties: ${error instanceof Error ? error.message : String(error)}`,
111
+ errors: [String(error)]
112
+ };
113
+ }
114
+ }
115
+ /**
116
+ * Update properties of a note
117
+ */
118
+ async updateProperties(filepath, newProperties) {
119
+ try {
120
+ // Validate new properties
121
+ const validation = this.validateProperties(newProperties);
122
+ if (!validation.valid) {
123
+ return {
124
+ success: false,
125
+ message: 'Invalid properties',
126
+ errors: validation.errors
127
+ };
128
+ }
129
+ // Get existing content and properties
130
+ const content = await this.client.getFileContents(filepath);
131
+ const existingProperties = this.parseProperties(content);
132
+ // Merge properties
133
+ const mergedProperties = this.mergeProperties(existingProperties, newProperties);
134
+ // Generate new frontmatter
135
+ const newFrontmatter = this.generateProperties(mergedProperties);
136
+ // Replace existing frontmatter or prepend to file
137
+ const newContent = content.replace(/^---[\s\S]*?---\n/, '') || '';
138
+ const updatedContent = newFrontmatter + newContent;
139
+ // Update file
140
+ await this.client.updateContent(filepath, updatedContent);
141
+ return {
142
+ success: true,
143
+ message: 'Properties updated successfully',
144
+ properties: mergedProperties
145
+ };
146
+ }
147
+ catch (error) {
148
+ return {
149
+ success: false,
150
+ message: `Failed to update properties: ${error instanceof Error ? error.message : String(error)}`,
151
+ errors: [String(error)]
152
+ };
153
+ }
154
+ }
155
+ }
156
+ //# sourceMappingURL=properties.js.map
@@ -0,0 +1,156 @@
1
+ import { BaseToolHandler } from "./tools.js";
2
+ import { PropertyManager } from "./properties.js";
3
+ const TOOL_NAMES = {
4
+ GET_PROPERTIES: "obsidian_get_properties",
5
+ UPDATE_PROPERTIES: "obsidian_update_properties"
6
+ };
7
+ export class GetPropertiesToolHandler extends BaseToolHandler {
8
+ propertyManager;
9
+ constructor(client) {
10
+ super(TOOL_NAMES.GET_PROPERTIES, client);
11
+ this.propertyManager = new PropertyManager(client);
12
+ }
13
+ getToolDescription() {
14
+ return {
15
+ name: this.name,
16
+ description: "Get properties from an Obsidian note's frontmatter.",
17
+ examples: [
18
+ {
19
+ description: "Get properties from a note",
20
+ args: {
21
+ filepath: "path/to/note.md"
22
+ }
23
+ }
24
+ ],
25
+ inputSchema: {
26
+ type: "object",
27
+ properties: {
28
+ filepath: {
29
+ type: "string",
30
+ description: "Path to the note file (relative to vault root)",
31
+ format: "path"
32
+ }
33
+ },
34
+ required: ["filepath"]
35
+ }
36
+ };
37
+ }
38
+ async runTool(args) {
39
+ try {
40
+ const result = await this.propertyManager.getProperties(args.filepath);
41
+ return this.createResponse(result);
42
+ }
43
+ catch (error) {
44
+ return this.handleError(error);
45
+ }
46
+ }
47
+ }
48
+ export class UpdatePropertiesToolHandler extends BaseToolHandler {
49
+ propertyManager;
50
+ constructor(client) {
51
+ super(TOOL_NAMES.UPDATE_PROPERTIES, client);
52
+ this.propertyManager = new PropertyManager(client);
53
+ }
54
+ getToolDescription() {
55
+ return {
56
+ name: this.name,
57
+ description: "Update properties in an Obsidian note's frontmatter.",
58
+ examples: [
59
+ {
60
+ description: "Update note properties",
61
+ args: {
62
+ filepath: "path/to/note.md",
63
+ properties: {
64
+ title: "New Title",
65
+ tags: ["#tag1", "#tag2"],
66
+ status: ["in-progress"]
67
+ }
68
+ }
69
+ }
70
+ ],
71
+ inputSchema: {
72
+ type: "object",
73
+ properties: {
74
+ filepath: {
75
+ type: "string",
76
+ description: "Path to the note file (relative to vault root)",
77
+ format: "path"
78
+ },
79
+ properties: {
80
+ type: "object",
81
+ description: "Properties to update",
82
+ properties: {
83
+ title: { type: "string" },
84
+ created: { type: "string", format: "date-time" },
85
+ modified: { type: "string", format: "date-time" },
86
+ author: { type: "string" },
87
+ type: {
88
+ type: "array",
89
+ items: {
90
+ type: "string",
91
+ enum: [
92
+ "concept",
93
+ "architecture",
94
+ "specification",
95
+ "protocol",
96
+ "api",
97
+ "research",
98
+ "implementation",
99
+ "guide",
100
+ "reference"
101
+ ]
102
+ }
103
+ },
104
+ tags: {
105
+ type: "array",
106
+ items: { type: "string", pattern: "^#" }
107
+ },
108
+ status: {
109
+ type: "array",
110
+ items: {
111
+ type: "string",
112
+ enum: ["draft", "in-progress", "review", "complete"]
113
+ }
114
+ },
115
+ version: { type: "string" },
116
+ platform: { type: "string" },
117
+ repository: { type: "string", format: "uri" },
118
+ dependencies: {
119
+ type: "array",
120
+ items: { type: "string" }
121
+ },
122
+ sources: {
123
+ type: "array",
124
+ items: { type: "string" }
125
+ },
126
+ urls: {
127
+ type: "array",
128
+ items: { type: "string", format: "uri" }
129
+ },
130
+ papers: {
131
+ type: "array",
132
+ items: { type: "string" }
133
+ },
134
+ custom: {
135
+ type: "object",
136
+ additionalProperties: true
137
+ }
138
+ },
139
+ additionalProperties: false
140
+ }
141
+ },
142
+ required: ["filepath", "properties"]
143
+ }
144
+ };
145
+ }
146
+ async runTool(args) {
147
+ try {
148
+ const result = await this.propertyManager.updateProperties(args.filepath, args.properties);
149
+ return this.createResponse(result);
150
+ }
151
+ catch (error) {
152
+ return this.handleError(error);
153
+ }
154
+ }
155
+ }
156
+ //# sourceMappingURL=propertyTools.js.map
@@ -0,0 +1,43 @@
1
+ import { z } from "zod";
2
+ // Define validation schemas
3
+ export const PropertyTypeEnum = z.enum([
4
+ "concept",
5
+ "architecture",
6
+ "specification",
7
+ "protocol",
8
+ "api",
9
+ "research",
10
+ "implementation",
11
+ "guide",
12
+ "reference"
13
+ ]);
14
+ export const StatusEnum = z.enum([
15
+ "draft",
16
+ "in-progress",
17
+ "review",
18
+ "complete"
19
+ ]);
20
+ export const ObsidianPropertiesSchema = z.object({
21
+ // Basic Metadata
22
+ title: z.string().optional(),
23
+ created: z.string().datetime().optional(),
24
+ modified: z.string().datetime().optional(),
25
+ author: z.string().optional(),
26
+ // Classification
27
+ type: z.array(PropertyTypeEnum).optional(),
28
+ // Organization
29
+ tags: z.array(z.string().startsWith("#")).optional(),
30
+ // Technical Metadata
31
+ status: z.array(StatusEnum).optional(),
32
+ version: z.string().optional(),
33
+ platform: z.string().optional(),
34
+ repository: z.string().url().optional(),
35
+ dependencies: z.array(z.string()).optional(),
36
+ // References
37
+ sources: z.array(z.string()).optional(),
38
+ urls: z.array(z.string().url()).optional(),
39
+ papers: z.array(z.string()).optional(),
40
+ // Custom Fields
41
+ custom: z.record(z.unknown()).optional()
42
+ });
43
+ //# sourceMappingURL=propertyTypes.js.map
package/build/server.js CHANGED
@@ -5,6 +5,7 @@ import { ListToolsRequestSchema, CallToolRequestSchema } from "@modelcontextprot
5
5
  import { ObsidianClient } from "./obsidian.js";
6
6
  import { ObsidianError, DEFAULT_RATE_LIMIT_CONFIG } from "./types.js";
7
7
  import { ListFilesInVaultToolHandler, ListFilesInDirToolHandler, GetFileContentsToolHandler, FindInFileToolHandler, AppendContentToolHandler, PatchContentToolHandler, ComplexSearchToolHandler } from "./tools.js";
8
+ import { GetPropertiesToolHandler, UpdatePropertiesToolHandler } from "./propertyTools.js";
8
9
  // Load environment variables
9
10
  config();
10
11
  const API_KEY = process.env.OBSIDIAN_API_KEY;
@@ -57,7 +58,9 @@ const handlers = [
57
58
  new FindInFileToolHandler(client),
58
59
  new AppendContentToolHandler(client),
59
60
  new PatchContentToolHandler(client),
60
- new ComplexSearchToolHandler(client)
61
+ new ComplexSearchToolHandler(client),
62
+ new GetPropertiesToolHandler(client),
63
+ new UpdatePropertiesToolHandler(client)
61
64
  ];
62
65
  handlers.forEach(handler => toolHandlers.set(handler.name, handler));
63
66
  // Create MCP server
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "obsidian-mcp-server",
3
- "version": "1.1.0",
3
+ "version": "1.2.0",
4
4
  "description": "Model Context Protocol server for Obsidian integration with token-aware response handling",
5
5
  "main": "build/index.js",
6
6
  "type": "module",
@@ -21,7 +21,9 @@
21
21
  "@modelcontextprotocol/sdk": "^1.4.0",
22
22
  "axios": "^1.7.9",
23
23
  "dotenv": "^16.4.7",
24
- "tiktoken": "^1.0.18"
24
+ "tiktoken": "^1.0.18",
25
+ "yaml": "^2.7.0",
26
+ "zod": "^3.24.1"
25
27
  },
26
28
  "devDependencies": {
27
29
  "@types/node": "^22.10.10",
@@ -44,6 +46,7 @@
44
46
  "tiktoken"
45
47
  ],
46
48
  "author": "cyanheads",
49
+ "license": "Apache-2.0",
47
50
  "repository": {
48
51
  "type": "git",
49
52
  "url": "git+ssh://git@github.com/cyanheads/obsidian-mcp-server.git"
@@ -0,0 +1,188 @@
1
+ import { parse, stringify } from 'yaml';
2
+ import { ObsidianClient } from './obsidian.js';
3
+ import {
4
+ ObsidianProperties,
5
+ ObsidianPropertiesSchema,
6
+ PropertyManagerResult,
7
+ ValidationResult
8
+ } from './propertyTypes.js';
9
+
10
+ export class PropertyManager {
11
+ constructor(private client: ObsidianClient) {}
12
+
13
+ /**
14
+ * Parse YAML frontmatter from note content
15
+ */
16
+ parseProperties(content: string): ObsidianProperties {
17
+ try {
18
+ // Extract frontmatter between --- markers
19
+ const match = content.match(/^---\n([\s\S]*?)\n---/);
20
+ if (!match) {
21
+ return {};
22
+ }
23
+
24
+ const frontmatter = match[1];
25
+ const properties = parse(frontmatter);
26
+
27
+ // Validate against schema
28
+ const result = ObsidianPropertiesSchema.safeParse(properties);
29
+ if (!result.success) {
30
+ console.warn('Property validation warnings:', result.error);
31
+ // Return partial valid properties rather than throwing
32
+ return properties;
33
+ }
34
+
35
+ return result.data;
36
+ } catch (error) {
37
+ console.error('Error parsing properties:', error);
38
+ return {};
39
+ }
40
+ }
41
+
42
+ /**
43
+ * Generate YAML frontmatter from properties
44
+ */
45
+ generateProperties(properties: Partial<ObsidianProperties>): string {
46
+ try {
47
+ // Remove undefined values
48
+ const cleanProperties = Object.fromEntries(
49
+ Object.entries(properties).filter(([_, v]) => v !== undefined)
50
+ );
51
+
52
+ // Generate YAML
53
+ const yaml = stringify(cleanProperties);
54
+ return `---\n${yaml}---\n`;
55
+ } catch (error) {
56
+ console.error('Error generating properties:', error);
57
+ throw error;
58
+ }
59
+ }
60
+
61
+ /**
62
+ * Validate property values
63
+ */
64
+ validateProperties(properties: Partial<ObsidianProperties>): ValidationResult {
65
+ const result = ObsidianPropertiesSchema.safeParse(properties);
66
+
67
+ if (result.success) {
68
+ return { valid: true, errors: [] };
69
+ }
70
+
71
+ return {
72
+ valid: false,
73
+ errors: result.error.errors.map(err =>
74
+ `${err.path.join('.')}: ${err.message}`
75
+ )
76
+ };
77
+ }
78
+
79
+ /**
80
+ * Merge new properties with existing ones
81
+ */
82
+ mergeProperties(
83
+ existing: ObsidianProperties,
84
+ updates: Partial<ObsidianProperties>
85
+ ): ObsidianProperties {
86
+ const merged = { ...existing };
87
+
88
+ for (const [key, value] of Object.entries(updates)) {
89
+ if (value === undefined) continue;
90
+
91
+ const currentValue = merged[key as keyof ObsidianProperties];
92
+
93
+ // Special handling for arrays - merge rather than replace
94
+ if (Array.isArray(value) && Array.isArray(currentValue)) {
95
+ merged[key as keyof ObsidianProperties] = [
96
+ ...new Set([...currentValue, ...value])
97
+ ] as any;
98
+ }
99
+ // Special handling for custom object - deep merge
100
+ else if (key === 'custom' && typeof value === 'object' && value !== null) {
101
+ merged.custom = {
102
+ ...merged.custom,
103
+ ...value
104
+ };
105
+ }
106
+ // Default case - replace value
107
+ else {
108
+ merged[key as keyof ObsidianProperties] = value as any;
109
+ }
110
+ }
111
+
112
+ // Always update modified date
113
+ merged.modified = new Date().toISOString();
114
+
115
+ return merged;
116
+ }
117
+
118
+ /**
119
+ * Get properties from a note
120
+ */
121
+ async getProperties(filepath: string): Promise<PropertyManagerResult> {
122
+ try {
123
+ const content = await this.client.getFileContents(filepath);
124
+ const properties = this.parseProperties(content);
125
+
126
+ return {
127
+ success: true,
128
+ message: 'Properties retrieved successfully',
129
+ properties
130
+ };
131
+ } catch (error) {
132
+ return {
133
+ success: false,
134
+ message: `Failed to get properties: ${error instanceof Error ? error.message : String(error)}`,
135
+ errors: [String(error)]
136
+ };
137
+ }
138
+ }
139
+
140
+ /**
141
+ * Update properties of a note
142
+ */
143
+ async updateProperties(
144
+ filepath: string,
145
+ newProperties: Partial<ObsidianProperties>
146
+ ): Promise<PropertyManagerResult> {
147
+ try {
148
+ // Validate new properties
149
+ const validation = this.validateProperties(newProperties);
150
+ if (!validation.valid) {
151
+ return {
152
+ success: false,
153
+ message: 'Invalid properties',
154
+ errors: validation.errors
155
+ };
156
+ }
157
+
158
+ // Get existing content and properties
159
+ const content = await this.client.getFileContents(filepath);
160
+ const existingProperties = this.parseProperties(content);
161
+
162
+ // Merge properties
163
+ const mergedProperties = this.mergeProperties(existingProperties, newProperties);
164
+
165
+ // Generate new frontmatter
166
+ const newFrontmatter = this.generateProperties(mergedProperties);
167
+
168
+ // Replace existing frontmatter or prepend to file
169
+ const newContent = content.replace(/^---[\s\S]*?---\n/, '') || '';
170
+ const updatedContent = newFrontmatter + newContent;
171
+
172
+ // Update file
173
+ await this.client.updateContent(filepath, updatedContent);
174
+
175
+ return {
176
+ success: true,
177
+ message: 'Properties updated successfully',
178
+ properties: mergedProperties
179
+ };
180
+ } catch (error) {
181
+ return {
182
+ success: false,
183
+ message: `Failed to update properties: ${error instanceof Error ? error.message : String(error)}`,
184
+ errors: [String(error)]
185
+ };
186
+ }
187
+ }
188
+ }
@@ -0,0 +1,177 @@
1
+ import { Tool, TextContent } from "@modelcontextprotocol/sdk/types.js";
2
+ import { ObsidianClient } from "./obsidian.js";
3
+ import { BaseToolHandler } from "./tools.js";
4
+ import { PropertyManager } from "./properties.js";
5
+ import { ObsidianProperties } from "./propertyTypes.js";
6
+
7
+ const TOOL_NAMES = {
8
+ GET_PROPERTIES: "obsidian_get_properties",
9
+ UPDATE_PROPERTIES: "obsidian_update_properties"
10
+ } as const;
11
+
12
+ interface GetPropertiesArgs {
13
+ filepath: string;
14
+ }
15
+
16
+ interface UpdatePropertiesArgs {
17
+ filepath: string;
18
+ properties: Partial<ObsidianProperties>;
19
+ }
20
+
21
+ export class GetPropertiesToolHandler extends BaseToolHandler<GetPropertiesArgs> {
22
+ private propertyManager: PropertyManager;
23
+
24
+ constructor(client: ObsidianClient) {
25
+ super(TOOL_NAMES.GET_PROPERTIES, client);
26
+ this.propertyManager = new PropertyManager(client);
27
+ }
28
+
29
+ getToolDescription(): Tool {
30
+ return {
31
+ name: this.name,
32
+ description: "Get properties from an Obsidian note's frontmatter.",
33
+ examples: [
34
+ {
35
+ description: "Get properties from a note",
36
+ args: {
37
+ filepath: "path/to/note.md"
38
+ }
39
+ }
40
+ ],
41
+ inputSchema: {
42
+ type: "object",
43
+ properties: {
44
+ filepath: {
45
+ type: "string",
46
+ description: "Path to the note file (relative to vault root)",
47
+ format: "path"
48
+ }
49
+ },
50
+ required: ["filepath"]
51
+ }
52
+ };
53
+ }
54
+
55
+ async runTool(args: GetPropertiesArgs): Promise<Array<TextContent>> {
56
+ try {
57
+ const result = await this.propertyManager.getProperties(args.filepath);
58
+ return this.createResponse(result);
59
+ } catch (error) {
60
+ return this.handleError(error);
61
+ }
62
+ }
63
+ }
64
+
65
+ export class UpdatePropertiesToolHandler extends BaseToolHandler<UpdatePropertiesArgs> {
66
+ private propertyManager: PropertyManager;
67
+
68
+ constructor(client: ObsidianClient) {
69
+ super(TOOL_NAMES.UPDATE_PROPERTIES, client);
70
+ this.propertyManager = new PropertyManager(client);
71
+ }
72
+
73
+ getToolDescription(): Tool {
74
+ return {
75
+ name: this.name,
76
+ description: "Update properties in an Obsidian note's frontmatter.",
77
+ examples: [
78
+ {
79
+ description: "Update note properties",
80
+ args: {
81
+ filepath: "path/to/note.md",
82
+ properties: {
83
+ title: "New Title",
84
+ tags: ["#tag1", "#tag2"],
85
+ status: ["in-progress"]
86
+ }
87
+ }
88
+ }
89
+ ],
90
+ inputSchema: {
91
+ type: "object",
92
+ properties: {
93
+ filepath: {
94
+ type: "string",
95
+ description: "Path to the note file (relative to vault root)",
96
+ format: "path"
97
+ },
98
+ properties: {
99
+ type: "object",
100
+ description: "Properties to update",
101
+ properties: {
102
+ title: { type: "string" },
103
+ created: { type: "string", format: "date-time" },
104
+ modified: { type: "string", format: "date-time" },
105
+ author: { type: "string" },
106
+ type: {
107
+ type: "array",
108
+ items: {
109
+ type: "string",
110
+ enum: [
111
+ "concept",
112
+ "architecture",
113
+ "specification",
114
+ "protocol",
115
+ "api",
116
+ "research",
117
+ "implementation",
118
+ "guide",
119
+ "reference"
120
+ ]
121
+ }
122
+ },
123
+ tags: {
124
+ type: "array",
125
+ items: { type: "string", pattern: "^#" }
126
+ },
127
+ status: {
128
+ type: "array",
129
+ items: {
130
+ type: "string",
131
+ enum: ["draft", "in-progress", "review", "complete"]
132
+ }
133
+ },
134
+ version: { type: "string" },
135
+ platform: { type: "string" },
136
+ repository: { type: "string", format: "uri" },
137
+ dependencies: {
138
+ type: "array",
139
+ items: { type: "string" }
140
+ },
141
+ sources: {
142
+ type: "array",
143
+ items: { type: "string" }
144
+ },
145
+ urls: {
146
+ type: "array",
147
+ items: { type: "string", format: "uri" }
148
+ },
149
+ papers: {
150
+ type: "array",
151
+ items: { type: "string" }
152
+ },
153
+ custom: {
154
+ type: "object",
155
+ additionalProperties: true
156
+ }
157
+ },
158
+ additionalProperties: false
159
+ }
160
+ },
161
+ required: ["filepath", "properties"]
162
+ }
163
+ };
164
+ }
165
+
166
+ async runTool(args: UpdatePropertiesArgs): Promise<Array<TextContent>> {
167
+ try {
168
+ const result = await this.propertyManager.updateProperties(
169
+ args.filepath,
170
+ args.properties
171
+ );
172
+ return this.createResponse(result);
173
+ } catch (error) {
174
+ return this.handleError(error);
175
+ }
176
+ }
177
+ }
@@ -0,0 +1,70 @@
1
+ import { z } from "zod";
2
+
3
+ // Define validation schemas
4
+ export const PropertyTypeEnum = z.enum([
5
+ "concept",
6
+ "architecture",
7
+ "specification",
8
+ "protocol",
9
+ "api",
10
+ "research",
11
+ "implementation",
12
+ "guide",
13
+ "reference"
14
+ ]);
15
+
16
+ export const StatusEnum = z.enum([
17
+ "draft",
18
+ "in-progress",
19
+ "review",
20
+ "complete"
21
+ ]);
22
+
23
+ export const ObsidianPropertiesSchema = z.object({
24
+ // Basic Metadata
25
+ title: z.string().optional(),
26
+ created: z.string().datetime().optional(),
27
+ modified: z.string().datetime().optional(),
28
+ author: z.string().optional(),
29
+
30
+ // Classification
31
+ type: z.array(PropertyTypeEnum).optional(),
32
+
33
+ // Organization
34
+ tags: z.array(z.string().startsWith("#")).optional(),
35
+
36
+ // Technical Metadata
37
+ status: z.array(StatusEnum).optional(),
38
+ version: z.string().optional(),
39
+ platform: z.string().optional(),
40
+ repository: z.string().url().optional(),
41
+ dependencies: z.array(z.string()).optional(),
42
+
43
+ // References
44
+ sources: z.array(z.string()).optional(),
45
+ urls: z.array(z.string().url()).optional(),
46
+ papers: z.array(z.string()).optional(),
47
+
48
+ // Custom Fields
49
+ custom: z.record(z.unknown()).optional()
50
+ });
51
+
52
+ export type ObsidianProperties = z.infer<typeof ObsidianPropertiesSchema>;
53
+
54
+ export interface PropertyOperation {
55
+ operation: 'get' | 'update' | 'patch';
56
+ filepath: string;
57
+ properties?: Partial<ObsidianProperties>;
58
+ }
59
+
60
+ export interface ValidationResult {
61
+ valid: boolean;
62
+ errors: string[];
63
+ }
64
+
65
+ export interface PropertyManagerResult {
66
+ success: boolean;
67
+ message: string;
68
+ properties?: ObsidianProperties;
69
+ errors?: string[];
70
+ }
package/src/server.ts CHANGED
@@ -21,6 +21,10 @@ import {
21
21
  PatchContentToolHandler,
22
22
  ComplexSearchToolHandler
23
23
  } from "./tools.js";
24
+ import {
25
+ GetPropertiesToolHandler,
26
+ UpdatePropertiesToolHandler
27
+ } from "./propertyTools.js";
24
28
 
25
29
  // Load environment variables
26
30
  config();
@@ -87,7 +91,9 @@ const handlers: AnyToolHandler[] = [
87
91
  new FindInFileToolHandler(client),
88
92
  new AppendContentToolHandler(client),
89
93
  new PatchContentToolHandler(client),
90
- new ComplexSearchToolHandler(client)
94
+ new ComplexSearchToolHandler(client),
95
+ new GetPropertiesToolHandler(client),
96
+ new UpdatePropertiesToolHandler(client)
91
97
  ];
92
98
 
93
99
  handlers.forEach(handler => toolHandlers.set(handler.name, handler));