obsidian-mcp-server 1.2.1 → 1.2.2
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/README.md +18 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.typescriptlang.org/)
|
|
4
4
|
[](https://modelcontextprotocol.io/)
|
|
5
|
-
[]()
|
|
6
6
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
7
7
|
[]()
|
|
8
8
|
[](https://github.com/cyanheads/obsidian-mcp-server)
|
|
@@ -16,25 +16,21 @@ Requires the Local REST API plugin in Obsidian.
|
|
|
16
16
|
## Features
|
|
17
17
|
|
|
18
18
|
### File Operations
|
|
19
|
-
-
|
|
20
|
-
- Content read/write operations with validation
|
|
19
|
+
- Atomic file/directory operations with validation
|
|
21
20
|
- Resource monitoring and cleanup
|
|
22
21
|
|
|
23
22
|
### Search System
|
|
24
|
-
- Full-text and JsonLogic
|
|
25
|
-
-
|
|
26
|
-
- Optimized query processing
|
|
23
|
+
- Full-text and JsonLogic search with context control
|
|
24
|
+
- Optimized query processing with token limits
|
|
27
25
|
|
|
28
26
|
### Property Management
|
|
29
|
-
- YAML frontmatter parsing and
|
|
30
|
-
-
|
|
31
|
-
- Automatic timestamp management
|
|
27
|
+
- YAML frontmatter parsing and intelligent merging
|
|
28
|
+
- Automatic timestamps (created by Obsidian, modified by server)
|
|
32
29
|
- Custom field support
|
|
33
30
|
|
|
34
31
|
### Security & Performance
|
|
35
|
-
- API key
|
|
36
|
-
-
|
|
37
|
-
- Resource management and health monitoring
|
|
32
|
+
- API key auth with rate limiting and SSL options
|
|
33
|
+
- Resource monitoring and health checks
|
|
38
34
|
|
|
39
35
|
## Installation
|
|
40
36
|
|
|
@@ -138,9 +134,8 @@ obsidian_update_properties: {
|
|
|
138
134
|
filepath: string, // Path relative to vault root
|
|
139
135
|
properties: {
|
|
140
136
|
title?: string,
|
|
141
|
-
created?: string, // ISO date
|
|
142
|
-
modified?: string, // ISO date (auto-updated)
|
|
143
137
|
author?: string,
|
|
138
|
+
// Note: created/modified timestamps are managed automatically
|
|
144
139
|
type?: Array<"concept" | "architecture" | "specification" |
|
|
145
140
|
"protocol" | "api" | "research" | "implementation" |
|
|
146
141
|
"guide" | "reference">,
|
|
@@ -161,28 +156,21 @@ obsidian_update_properties: {
|
|
|
161
156
|
## Best Practices
|
|
162
157
|
|
|
163
158
|
### File Operations
|
|
164
|
-
- Use atomic operations
|
|
165
|
-
-
|
|
166
|
-
- Implement proper error handling
|
|
167
|
-
- Monitor operation performance
|
|
159
|
+
- Use atomic operations with validation
|
|
160
|
+
- Handle errors and monitor performance
|
|
168
161
|
|
|
169
162
|
### Search Implementation
|
|
170
|
-
- Optimize
|
|
171
|
-
-
|
|
172
|
-
- Handle large result sets
|
|
173
|
-
- Consider token limits
|
|
163
|
+
- Optimize queries and control context size
|
|
164
|
+
- Handle large results within token limits
|
|
174
165
|
|
|
175
166
|
### Property Management
|
|
176
|
-
-
|
|
177
|
-
-
|
|
178
|
-
-
|
|
179
|
-
- Consider custom field implications
|
|
167
|
+
- Use appropriate types and validate updates
|
|
168
|
+
- Handle arrays and custom fields properly
|
|
169
|
+
- Never set timestamps (managed automatically)
|
|
180
170
|
|
|
181
171
|
### Error Prevention
|
|
182
|
-
- Validate inputs
|
|
183
|
-
-
|
|
184
|
-
- Monitor error patterns
|
|
185
|
-
- Check rate limits
|
|
172
|
+
- Validate inputs and handle errors gracefully
|
|
173
|
+
- Monitor patterns and respect rate limits
|
|
186
174
|
|
|
187
175
|
## Contributing
|
|
188
176
|
|