obsidian-mcp-server 2.0.7 → 3.1.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.
Files changed (254) hide show
  1. package/CLAUDE.md +364 -0
  2. package/Dockerfile +99 -0
  3. package/LICENSE +4 -6
  4. package/README.md +246 -206
  5. package/changelog/3.0.x/3.0.0.md +102 -0
  6. package/changelog/3.1.x/3.1.0.md +26 -0
  7. package/changelog/template.md +51 -0
  8. package/dist/config/server-config.d.ts +19 -0
  9. package/dist/config/server-config.d.ts.map +1 -0
  10. package/dist/config/server-config.js +55 -0
  11. package/dist/config/server-config.js.map +1 -0
  12. package/dist/index.d.ts +7 -0
  13. package/dist/index.d.ts.map +1 -0
  14. package/dist/index.js +23 -295
  15. package/dist/index.js.map +1 -0
  16. package/dist/mcp-server/prompts/definitions/index.d.ts +8 -0
  17. package/dist/mcp-server/prompts/definitions/index.d.ts.map +1 -0
  18. package/dist/mcp-server/prompts/definitions/index.js +8 -0
  19. package/dist/mcp-server/prompts/definitions/index.js.map +1 -0
  20. package/dist/mcp-server/resources/definitions/index.d.ts +36 -0
  21. package/dist/mcp-server/resources/definitions/index.d.ts.map +1 -0
  22. package/dist/mcp-server/resources/definitions/index.js +9 -0
  23. package/dist/mcp-server/resources/definitions/index.js.map +1 -0
  24. package/dist/mcp-server/resources/definitions/obsidian-status.resource.d.ts +23 -0
  25. package/dist/mcp-server/resources/definitions/obsidian-status.resource.d.ts.map +1 -0
  26. package/dist/mcp-server/resources/definitions/obsidian-status.resource.js +47 -0
  27. package/dist/mcp-server/resources/definitions/obsidian-status.resource.js.map +1 -0
  28. package/dist/mcp-server/resources/definitions/obsidian-tags.resource.d.ts +13 -0
  29. package/dist/mcp-server/resources/definitions/obsidian-tags.resource.d.ts.map +1 -0
  30. package/dist/mcp-server/resources/definitions/obsidian-tags.resource.js +30 -0
  31. package/dist/mcp-server/resources/definitions/obsidian-tags.resource.js.map +1 -0
  32. package/dist/mcp-server/resources/definitions/obsidian-vault-note.resource.d.ts +21 -0
  33. package/dist/mcp-server/resources/definitions/obsidian-vault-note.resource.d.ts.map +1 -0
  34. package/dist/mcp-server/resources/definitions/obsidian-vault-note.resource.js +38 -0
  35. package/dist/mcp-server/resources/definitions/obsidian-vault-note.resource.js.map +1 -0
  36. package/dist/mcp-server/tools/definitions/_shared/schemas.d.ts +45 -0
  37. package/dist/mcp-server/tools/definitions/_shared/schemas.d.ts.map +1 -0
  38. package/dist/mcp-server/tools/definitions/_shared/schemas.js +66 -0
  39. package/dist/mcp-server/tools/definitions/_shared/schemas.js.map +1 -0
  40. package/dist/mcp-server/tools/definitions/_shared/suggest-paths.d.ts +51 -0
  41. package/dist/mcp-server/tools/definitions/_shared/suggest-paths.d.ts.map +1 -0
  42. package/dist/mcp-server/tools/definitions/_shared/suggest-paths.js +120 -0
  43. package/dist/mcp-server/tools/definitions/_shared/suggest-paths.js.map +1 -0
  44. package/dist/mcp-server/tools/definitions/index.d.ts +582 -0
  45. package/dist/mcp-server/tools/definitions/index.d.ts.map +1 -0
  46. package/dist/mcp-server/tools/definitions/index.js +40 -0
  47. package/dist/mcp-server/tools/definitions/index.js.map +1 -0
  48. package/dist/mcp-server/tools/definitions/obsidian-append-to-note.tool.d.ts +42 -0
  49. package/dist/mcp-server/tools/definitions/obsidian-append-to-note.tool.d.ts.map +1 -0
  50. package/dist/mcp-server/tools/definitions/obsidian-append-to-note.tool.js +58 -0
  51. package/dist/mcp-server/tools/definitions/obsidian-append-to-note.tool.js.map +1 -0
  52. package/dist/mcp-server/tools/definitions/obsidian-delete-note.tool.d.ts +46 -0
  53. package/dist/mcp-server/tools/definitions/obsidian-delete-note.tool.d.ts.map +1 -0
  54. package/dist/mcp-server/tools/definitions/obsidian-delete-note.tool.js +66 -0
  55. package/dist/mcp-server/tools/definitions/obsidian-delete-note.tool.js.map +1 -0
  56. package/dist/mcp-server/tools/definitions/obsidian-execute-command.tool.d.ts +19 -0
  57. package/dist/mcp-server/tools/definitions/obsidian-execute-command.tool.d.ts.map +1 -0
  58. package/dist/mcp-server/tools/definitions/obsidian-execute-command.tool.js +43 -0
  59. package/dist/mcp-server/tools/definitions/obsidian-execute-command.tool.js.map +1 -0
  60. package/dist/mcp-server/tools/definitions/obsidian-get-note.tool.d.ts +92 -0
  61. package/dist/mcp-server/tools/definitions/obsidian-get-note.tool.d.ts.map +1 -0
  62. package/dist/mcp-server/tools/definitions/obsidian-get-note.tool.js +245 -0
  63. package/dist/mcp-server/tools/definitions/obsidian-get-note.tool.js.map +1 -0
  64. package/dist/mcp-server/tools/definitions/obsidian-list-commands.tool.d.ts +13 -0
  65. package/dist/mcp-server/tools/definitions/obsidian-list-commands.tool.d.ts.map +1 -0
  66. package/dist/mcp-server/tools/definitions/obsidian-list-commands.tool.js +38 -0
  67. package/dist/mcp-server/tools/definitions/obsidian-list-commands.tool.js.map +1 -0
  68. package/dist/mcp-server/tools/definitions/obsidian-list-notes.tool.d.ts +59 -0
  69. package/dist/mcp-server/tools/definitions/obsidian-list-notes.tool.d.ts.map +1 -0
  70. package/dist/mcp-server/tools/definitions/obsidian-list-notes.tool.js +273 -0
  71. package/dist/mcp-server/tools/definitions/obsidian-list-notes.tool.js.map +1 -0
  72. package/dist/mcp-server/tools/definitions/obsidian-list-tags.tool.d.ts +13 -0
  73. package/dist/mcp-server/tools/definitions/obsidian-list-tags.tool.d.ts.map +1 -0
  74. package/dist/mcp-server/tools/definitions/obsidian-list-tags.tool.js +38 -0
  75. package/dist/mcp-server/tools/definitions/obsidian-list-tags.tool.js.map +1 -0
  76. package/dist/mcp-server/tools/definitions/obsidian-manage-frontmatter.tool.d.ts +68 -0
  77. package/dist/mcp-server/tools/definitions/obsidian-manage-frontmatter.tool.d.ts.map +1 -0
  78. package/dist/mcp-server/tools/definitions/obsidian-manage-frontmatter.tool.js +178 -0
  79. package/dist/mcp-server/tools/definitions/obsidian-manage-frontmatter.tool.js.map +1 -0
  80. package/dist/mcp-server/tools/definitions/obsidian-manage-tags.tool.d.ts +77 -0
  81. package/dist/mcp-server/tools/definitions/obsidian-manage-tags.tool.d.ts.map +1 -0
  82. package/dist/mcp-server/tools/definitions/obsidian-manage-tags.tool.js +172 -0
  83. package/dist/mcp-server/tools/definitions/obsidian-manage-tags.tool.js.map +1 -0
  84. package/dist/mcp-server/tools/definitions/obsidian-open-in-ui.tool.d.ts +22 -0
  85. package/dist/mcp-server/tools/definitions/obsidian-open-in-ui.tool.d.ts.map +1 -0
  86. package/dist/mcp-server/tools/definitions/obsidian-open-in-ui.tool.js +88 -0
  87. package/dist/mcp-server/tools/definitions/obsidian-open-in-ui.tool.js.map +1 -0
  88. package/dist/mcp-server/tools/definitions/obsidian-patch-note.tool.d.ts +81 -0
  89. package/dist/mcp-server/tools/definitions/obsidian-patch-note.tool.d.ts.map +1 -0
  90. package/dist/mcp-server/tools/definitions/obsidian-patch-note.tool.js +83 -0
  91. package/dist/mcp-server/tools/definitions/obsidian-patch-note.tool.js.map +1 -0
  92. package/dist/mcp-server/tools/definitions/obsidian-replace-in-note.tool.d.ts +59 -0
  93. package/dist/mcp-server/tools/definitions/obsidian-replace-in-note.tool.d.ts.map +1 -0
  94. package/dist/mcp-server/tools/definitions/obsidian-replace-in-note.tool.js +167 -0
  95. package/dist/mcp-server/tools/definitions/obsidian-replace-in-note.tool.js.map +1 -0
  96. package/dist/mcp-server/tools/definitions/obsidian-search-notes.tool.d.ts +76 -0
  97. package/dist/mcp-server/tools/definitions/obsidian-search-notes.tool.d.ts.map +1 -0
  98. package/dist/mcp-server/tools/definitions/obsidian-search-notes.tool.js +244 -0
  99. package/dist/mcp-server/tools/definitions/obsidian-search-notes.tool.js.map +1 -0
  100. package/dist/mcp-server/tools/definitions/obsidian-write-note.tool.d.ts +48 -0
  101. package/dist/mcp-server/tools/definitions/obsidian-write-note.tool.d.ts.map +1 -0
  102. package/dist/mcp-server/tools/definitions/obsidian-write-note.tool.js +100 -0
  103. package/dist/mcp-server/tools/definitions/obsidian-write-note.tool.js.map +1 -0
  104. package/dist/services/obsidian/frontmatter-ops.d.ts +34 -0
  105. package/dist/services/obsidian/frontmatter-ops.d.ts.map +1 -0
  106. package/dist/services/obsidian/frontmatter-ops.js +230 -0
  107. package/dist/services/obsidian/frontmatter-ops.js.map +1 -0
  108. package/dist/services/obsidian/obsidian-service.d.ts +83 -0
  109. package/dist/services/obsidian/obsidian-service.d.ts.map +1 -0
  110. package/dist/services/obsidian/obsidian-service.js +435 -0
  111. package/dist/services/obsidian/obsidian-service.js.map +1 -0
  112. package/dist/services/obsidian/section-extractor.d.ts +13 -0
  113. package/dist/services/obsidian/section-extractor.d.ts.map +1 -0
  114. package/dist/services/obsidian/section-extractor.js +124 -0
  115. package/dist/services/obsidian/section-extractor.js.map +1 -0
  116. package/dist/services/obsidian/types.d.ts +91 -0
  117. package/dist/services/obsidian/types.d.ts.map +1 -0
  118. package/dist/services/obsidian/types.js +7 -0
  119. package/dist/services/obsidian/types.js.map +1 -0
  120. package/package.json +63 -69
  121. package/server.json +167 -0
  122. package/CHANGELOG.md +0 -124
  123. package/dist/config/index.d.ts +0 -41
  124. package/dist/config/index.js +0 -191
  125. package/dist/mcp-server/server.d.ts +0 -33
  126. package/dist/mcp-server/server.js +0 -211
  127. package/dist/mcp-server/tools/obsidianDeleteNoteTool/index.d.ts +0 -12
  128. package/dist/mcp-server/tools/obsidianDeleteNoteTool/index.js +0 -12
  129. package/dist/mcp-server/tools/obsidianDeleteNoteTool/logic.d.ts +0 -51
  130. package/dist/mcp-server/tools/obsidianDeleteNoteTool/logic.js +0 -168
  131. package/dist/mcp-server/tools/obsidianDeleteNoteTool/registration.d.ts +0 -19
  132. package/dist/mcp-server/tools/obsidianDeleteNoteTool/registration.js +0 -91
  133. package/dist/mcp-server/tools/obsidianGlobalSearchTool/index.d.ts +0 -12
  134. package/dist/mcp-server/tools/obsidianGlobalSearchTool/index.js +0 -12
  135. package/dist/mcp-server/tools/obsidianGlobalSearchTool/logic.d.ts +0 -77
  136. package/dist/mcp-server/tools/obsidianGlobalSearchTool/logic.js +0 -341
  137. package/dist/mcp-server/tools/obsidianGlobalSearchTool/registration.d.ts +0 -18
  138. package/dist/mcp-server/tools/obsidianGlobalSearchTool/registration.js +0 -69
  139. package/dist/mcp-server/tools/obsidianListNotesTool/index.d.ts +0 -12
  140. package/dist/mcp-server/tools/obsidianListNotesTool/index.js +0 -12
  141. package/dist/mcp-server/tools/obsidianListNotesTool/logic.d.ts +0 -68
  142. package/dist/mcp-server/tools/obsidianListNotesTool/logic.js +0 -215
  143. package/dist/mcp-server/tools/obsidianListNotesTool/registration.d.ts +0 -23
  144. package/dist/mcp-server/tools/obsidianListNotesTool/registration.js +0 -98
  145. package/dist/mcp-server/tools/obsidianManageFrontmatterTool/index.d.ts +0 -3
  146. package/dist/mcp-server/tools/obsidianManageFrontmatterTool/index.js +0 -2
  147. package/dist/mcp-server/tools/obsidianManageFrontmatterTool/logic.d.ts +0 -42
  148. package/dist/mcp-server/tools/obsidianManageFrontmatterTool/logic.js +0 -152
  149. package/dist/mcp-server/tools/obsidianManageFrontmatterTool/registration.d.ts +0 -3
  150. package/dist/mcp-server/tools/obsidianManageFrontmatterTool/registration.js +0 -52
  151. package/dist/mcp-server/tools/obsidianManageTagsTool/index.d.ts +0 -3
  152. package/dist/mcp-server/tools/obsidianManageTagsTool/index.js +0 -2
  153. package/dist/mcp-server/tools/obsidianManageTagsTool/logic.d.ts +0 -28
  154. package/dist/mcp-server/tools/obsidianManageTagsTool/logic.js +0 -161
  155. package/dist/mcp-server/tools/obsidianManageTagsTool/registration.d.ts +0 -3
  156. package/dist/mcp-server/tools/obsidianManageTagsTool/registration.js +0 -52
  157. package/dist/mcp-server/tools/obsidianReadNoteTool/index.d.ts +0 -12
  158. package/dist/mcp-server/tools/obsidianReadNoteTool/index.js +0 -12
  159. package/dist/mcp-server/tools/obsidianReadNoteTool/logic.d.ts +0 -87
  160. package/dist/mcp-server/tools/obsidianReadNoteTool/logic.js +0 -216
  161. package/dist/mcp-server/tools/obsidianReadNoteTool/registration.d.ts +0 -20
  162. package/dist/mcp-server/tools/obsidianReadNoteTool/registration.js +0 -101
  163. package/dist/mcp-server/tools/obsidianSearchReplaceTool/index.d.ts +0 -12
  164. package/dist/mcp-server/tools/obsidianSearchReplaceTool/index.js +0 -12
  165. package/dist/mcp-server/tools/obsidianSearchReplaceTool/logic.d.ts +0 -255
  166. package/dist/mcp-server/tools/obsidianSearchReplaceTool/logic.js +0 -583
  167. package/dist/mcp-server/tools/obsidianSearchReplaceTool/registration.d.ts +0 -22
  168. package/dist/mcp-server/tools/obsidianSearchReplaceTool/registration.js +0 -111
  169. package/dist/mcp-server/tools/obsidianUpdateNoteTool/index.d.ts +0 -12
  170. package/dist/mcp-server/tools/obsidianUpdateNoteTool/index.js +0 -12
  171. package/dist/mcp-server/tools/obsidianUpdateNoteTool/logic.d.ts +0 -183
  172. package/dist/mcp-server/tools/obsidianUpdateNoteTool/logic.js +0 -490
  173. package/dist/mcp-server/tools/obsidianUpdateNoteTool/registration.d.ts +0 -21
  174. package/dist/mcp-server/tools/obsidianUpdateNoteTool/registration.js +0 -108
  175. package/dist/mcp-server/transports/auth/core/authContext.d.ts +0 -33
  176. package/dist/mcp-server/transports/auth/core/authContext.js +0 -24
  177. package/dist/mcp-server/transports/auth/core/authTypes.d.ts +0 -17
  178. package/dist/mcp-server/transports/auth/core/authTypes.js +0 -5
  179. package/dist/mcp-server/transports/auth/core/authUtils.d.ts +0 -18
  180. package/dist/mcp-server/transports/auth/core/authUtils.js +0 -45
  181. package/dist/mcp-server/transports/auth/index.d.ts +0 -10
  182. package/dist/mcp-server/transports/auth/index.js +0 -9
  183. package/dist/mcp-server/transports/auth/strategies/jwt/jwtMiddleware.d.ts +0 -27
  184. package/dist/mcp-server/transports/auth/strategies/jwt/jwtMiddleware.js +0 -149
  185. package/dist/mcp-server/transports/auth/strategies/oauth/oauthMiddleware.d.ts +0 -20
  186. package/dist/mcp-server/transports/auth/strategies/oauth/oauthMiddleware.js +0 -124
  187. package/dist/mcp-server/transports/httpErrorHandler.d.ts +0 -26
  188. package/dist/mcp-server/transports/httpErrorHandler.js +0 -73
  189. package/dist/mcp-server/transports/httpTransport.d.ts +0 -21
  190. package/dist/mcp-server/transports/httpTransport.js +0 -208
  191. package/dist/mcp-server/transports/stdioTransport.d.ts +0 -42
  192. package/dist/mcp-server/transports/stdioTransport.js +0 -63
  193. package/dist/services/obsidianRestAPI/index.d.ts +0 -15
  194. package/dist/services/obsidianRestAPI/index.js +0 -17
  195. package/dist/services/obsidianRestAPI/methods/activeFileMethods.d.ts +0 -38
  196. package/dist/services/obsidianRestAPI/methods/activeFileMethods.js +0 -62
  197. package/dist/services/obsidianRestAPI/methods/commandMethods.d.ts +0 -22
  198. package/dist/services/obsidianRestAPI/methods/commandMethods.js +0 -31
  199. package/dist/services/obsidianRestAPI/methods/openMethods.d.ts +0 -16
  200. package/dist/services/obsidianRestAPI/methods/openMethods.js +0 -21
  201. package/dist/services/obsidianRestAPI/methods/patchMethods.d.ts +0 -37
  202. package/dist/services/obsidianRestAPI/methods/patchMethods.js +0 -94
  203. package/dist/services/obsidianRestAPI/methods/periodicNoteMethods.d.ts +0 -42
  204. package/dist/services/obsidianRestAPI/methods/periodicNoteMethods.js +0 -66
  205. package/dist/services/obsidianRestAPI/methods/searchMethods.d.ts +0 -25
  206. package/dist/services/obsidianRestAPI/methods/searchMethods.js +0 -36
  207. package/dist/services/obsidianRestAPI/methods/vaultMethods.d.ts +0 -58
  208. package/dist/services/obsidianRestAPI/methods/vaultMethods.js +0 -144
  209. package/dist/services/obsidianRestAPI/service.d.ts +0 -195
  210. package/dist/services/obsidianRestAPI/service.js +0 -379
  211. package/dist/services/obsidianRestAPI/types.d.ts +0 -127
  212. package/dist/services/obsidianRestAPI/types.js +0 -7
  213. package/dist/services/obsidianRestAPI/vaultCache/index.d.ts +0 -4
  214. package/dist/services/obsidianRestAPI/vaultCache/index.js +0 -4
  215. package/dist/services/obsidianRestAPI/vaultCache/service.d.ts +0 -88
  216. package/dist/services/obsidianRestAPI/vaultCache/service.js +0 -299
  217. package/dist/types-global/errors.d.ts +0 -73
  218. package/dist/types-global/errors.js +0 -71
  219. package/dist/utils/index.d.ts +0 -5
  220. package/dist/utils/index.js +0 -13
  221. package/dist/utils/internal/asyncUtils.d.ts +0 -54
  222. package/dist/utils/internal/asyncUtils.js +0 -101
  223. package/dist/utils/internal/errorHandler.d.ts +0 -176
  224. package/dist/utils/internal/errorHandler.js +0 -351
  225. package/dist/utils/internal/index.d.ts +0 -4
  226. package/dist/utils/internal/index.js +0 -4
  227. package/dist/utils/internal/logger.d.ts +0 -141
  228. package/dist/utils/internal/logger.js +0 -406
  229. package/dist/utils/internal/requestContext.d.ts +0 -83
  230. package/dist/utils/internal/requestContext.js +0 -72
  231. package/dist/utils/metrics/index.d.ts +0 -1
  232. package/dist/utils/metrics/index.js +0 -1
  233. package/dist/utils/metrics/tokenCounter.d.ts +0 -27
  234. package/dist/utils/metrics/tokenCounter.js +0 -128
  235. package/dist/utils/obsidian/index.d.ts +0 -5
  236. package/dist/utils/obsidian/index.js +0 -5
  237. package/dist/utils/obsidian/obsidianApiUtils.d.ts +0 -14
  238. package/dist/utils/obsidian/obsidianApiUtils.js +0 -29
  239. package/dist/utils/obsidian/obsidianStatUtils.d.ts +0 -68
  240. package/dist/utils/obsidian/obsidianStatUtils.js +0 -143
  241. package/dist/utils/parsing/dateParser.d.ts +0 -56
  242. package/dist/utils/parsing/dateParser.js +0 -104
  243. package/dist/utils/parsing/index.d.ts +0 -2
  244. package/dist/utils/parsing/index.js +0 -3
  245. package/dist/utils/parsing/jsonParser.d.ts +0 -80
  246. package/dist/utils/parsing/jsonParser.js +0 -133
  247. package/dist/utils/security/idGenerator.d.ts +0 -140
  248. package/dist/utils/security/idGenerator.js +0 -194
  249. package/dist/utils/security/index.d.ts +0 -3
  250. package/dist/utils/security/index.js +0 -3
  251. package/dist/utils/security/rateLimiter.d.ts +0 -156
  252. package/dist/utils/security/rateLimiter.js +0 -235
  253. package/dist/utils/security/sanitization.d.ts +0 -244
  254. package/dist/utils/security/sanitization.js +0 -599
@@ -1,191 +0,0 @@
1
- import dotenv from "dotenv";
2
- import { existsSync, mkdirSync, readFileSync, statSync } from "fs";
3
- import path, { dirname, join } from "path";
4
- import { fileURLToPath } from "url";
5
- import { z } from "zod";
6
- dotenv.config();
7
- // --- Determine Project Root ---
8
- /**
9
- * Finds the project root directory by searching upwards for package.json.
10
- * @param startDir The directory to start searching from.
11
- * @returns The absolute path to the project root, or throws an error if not found.
12
- */
13
- const findProjectRoot = (startDir) => {
14
- let currentDir = startDir;
15
- while (true) {
16
- const packageJsonPath = join(currentDir, "package.json");
17
- if (existsSync(packageJsonPath)) {
18
- return currentDir;
19
- }
20
- const parentDir = dirname(currentDir);
21
- if (parentDir === currentDir) {
22
- // Reached the root of the filesystem without finding package.json
23
- throw new Error(`Could not find project root (package.json) starting from ${startDir}`);
24
- }
25
- currentDir = parentDir;
26
- }
27
- };
28
- let projectRoot;
29
- try {
30
- // For ESM, __dirname is not available directly.
31
- const currentModuleDir = dirname(fileURLToPath(import.meta.url));
32
- projectRoot = findProjectRoot(currentModuleDir);
33
- }
34
- catch (error) {
35
- console.error(`FATAL: Error determining project root: ${error.message}`);
36
- projectRoot = process.cwd();
37
- console.warn(`Warning: Using process.cwd() (${projectRoot}) as fallback project root.`);
38
- }
39
- // --- End Determine Project Root ---
40
- const pkgPath = join(projectRoot, "package.json");
41
- let pkg = { name: "obsidian-mcp-server", version: "0.0.0" };
42
- try {
43
- pkg = JSON.parse(readFileSync(pkgPath, "utf-8"));
44
- }
45
- catch (error) {
46
- if (process.stderr.isTTY) {
47
- console.error("Warning: Could not read package.json for default config values. Using hardcoded defaults.", error);
48
- }
49
- }
50
- /**
51
- * Zod schema for validating environment variables.
52
- * @private
53
- */
54
- const EnvSchema = z.object({
55
- MCP_SERVER_NAME: z.string().optional(),
56
- MCP_SERVER_VERSION: z.string().optional(),
57
- MCP_LOG_LEVEL: z.string().default("info"),
58
- LOGS_DIR: z.string().default(path.join(projectRoot, "logs")),
59
- NODE_ENV: z.string().default("development"),
60
- MCP_TRANSPORT_TYPE: z.enum(["stdio", "http"]).default("stdio"),
61
- MCP_HTTP_PORT: z.coerce.number().int().positive().default(3010),
62
- MCP_HTTP_HOST: z.string().default("127.0.0.1"),
63
- MCP_ALLOWED_ORIGINS: z.string().optional(),
64
- MCP_AUTH_MODE: z.enum(["jwt", "oauth"]).optional(),
65
- MCP_AUTH_SECRET_KEY: z
66
- .string()
67
- .min(32, "MCP_AUTH_SECRET_KEY must be at least 32 characters long for security")
68
- .optional(),
69
- OAUTH_ISSUER_URL: z.string().url().optional(),
70
- OAUTH_AUDIENCE: z.string().optional(),
71
- OAUTH_JWKS_URI: z.string().url().optional(),
72
- // --- Obsidian Specific Config ---
73
- OBSIDIAN_API_KEY: z.string().min(1, "OBSIDIAN_API_KEY cannot be empty"),
74
- OBSIDIAN_BASE_URL: z.string().url().default("http://127.0.0.1:27123"),
75
- OBSIDIAN_VERIFY_SSL: z
76
- .string()
77
- .transform((val) => val.toLowerCase() === "true")
78
- .default("false"),
79
- OBSIDIAN_CACHE_REFRESH_INTERVAL_MIN: z.coerce
80
- .number()
81
- .int()
82
- .positive()
83
- .default(10),
84
- OBSIDIAN_ENABLE_CACHE: z
85
- .string()
86
- .transform((val) => val.toLowerCase() === "true")
87
- .default("true"),
88
- OBSIDIAN_API_SEARCH_TIMEOUT_MS: z.coerce
89
- .number()
90
- .int()
91
- .positive()
92
- .default(30000),
93
- });
94
- const parsedEnv = EnvSchema.safeParse(process.env);
95
- if (!parsedEnv.success) {
96
- const errorDetails = parsedEnv.error.flatten().fieldErrors;
97
- if (process.stderr.isTTY) {
98
- console.error("❌ Invalid environment variables:", errorDetails);
99
- }
100
- throw new Error(`Invalid environment configuration. Please check your .env file or environment variables. Details: ${JSON.stringify(errorDetails)}`);
101
- }
102
- const env = parsedEnv.data;
103
- // --- Directory Ensurance Function ---
104
- const ensureDirectory = (dirPath, rootDir, dirName) => {
105
- const resolvedDirPath = path.isAbsolute(dirPath)
106
- ? dirPath
107
- : path.resolve(rootDir, dirPath);
108
- if (!resolvedDirPath.startsWith(rootDir + path.sep) &&
109
- resolvedDirPath !== rootDir) {
110
- if (process.stderr.isTTY) {
111
- console.error(`Error: ${dirName} path "${dirPath}" resolves to "${resolvedDirPath}", which is outside the project boundary "${rootDir}".`);
112
- }
113
- return null;
114
- }
115
- if (!existsSync(resolvedDirPath)) {
116
- try {
117
- mkdirSync(resolvedDirPath, { recursive: true });
118
- }
119
- catch (err) {
120
- if (process.stderr.isTTY) {
121
- console.error(`Error creating ${dirName} directory at ${resolvedDirPath}: ${err instanceof Error ? err.message : String(err)}`);
122
- }
123
- return null;
124
- }
125
- }
126
- else {
127
- try {
128
- if (!statSync(resolvedDirPath).isDirectory()) {
129
- if (process.stderr.isTTY) {
130
- console.error(`Error: ${dirName} path ${resolvedDirPath} exists but is not a directory.`);
131
- }
132
- return null;
133
- }
134
- }
135
- catch (statError) {
136
- if (process.stderr.isTTY) {
137
- console.error(`Error accessing ${dirName} path ${resolvedDirPath}: ${statError.message}`);
138
- }
139
- return null;
140
- }
141
- }
142
- return resolvedDirPath;
143
- };
144
- // --- End Directory Ensurance Function ---
145
- const validatedLogsPath = ensureDirectory(env.LOGS_DIR, projectRoot, "logs");
146
- if (!validatedLogsPath) {
147
- if (process.stderr.isTTY) {
148
- console.error("FATAL: Logs directory configuration is invalid or could not be created. Please check permissions and path. Exiting.");
149
- }
150
- process.exit(1);
151
- }
152
- /**
153
- * Main application configuration object.
154
- */
155
- export const config = {
156
- pkg,
157
- mcpServerName: env.MCP_SERVER_NAME || pkg.name,
158
- mcpServerVersion: env.MCP_SERVER_VERSION || pkg.version,
159
- logLevel: env.MCP_LOG_LEVEL,
160
- logsPath: validatedLogsPath,
161
- environment: env.NODE_ENV,
162
- mcpTransportType: env.MCP_TRANSPORT_TYPE,
163
- mcpHttpPort: env.MCP_HTTP_PORT,
164
- mcpHttpHost: env.MCP_HTTP_HOST,
165
- mcpAllowedOrigins: env.MCP_ALLOWED_ORIGINS?.split(",")
166
- .map((origin) => origin.trim())
167
- .filter(Boolean),
168
- mcpAuthMode: env.MCP_AUTH_MODE,
169
- mcpAuthSecretKey: env.MCP_AUTH_SECRET_KEY,
170
- oauthIssuerUrl: env.OAUTH_ISSUER_URL,
171
- oauthAudience: env.OAUTH_AUDIENCE,
172
- oauthJwksUri: env.OAUTH_JWKS_URI,
173
- obsidianApiKey: env.OBSIDIAN_API_KEY,
174
- obsidianBaseUrl: env.OBSIDIAN_BASE_URL,
175
- obsidianVerifySsl: env.OBSIDIAN_VERIFY_SSL,
176
- obsidianCacheRefreshIntervalMin: env.OBSIDIAN_CACHE_REFRESH_INTERVAL_MIN,
177
- obsidianEnableCache: env.OBSIDIAN_ENABLE_CACHE,
178
- obsidianApiSearchTimeoutMs: env.OBSIDIAN_API_SEARCH_TIMEOUT_MS,
179
- };
180
- /**
181
- * The configured logging level for the application.
182
- * Exported separately for convenience (e.g., logger initialization).
183
- * @type {string}
184
- */
185
- export const logLevel = config.logLevel;
186
- /**
187
- * The configured runtime environment for the application.
188
- * Exported separately for convenience.
189
- * @type {string}
190
- */
191
- export const environment = config.environment;
@@ -1,33 +0,0 @@
1
- /**
2
- * @fileoverview Main entry point for the MCP (Model Context Protocol) server.
3
- * This file orchestrates the server's lifecycle:
4
- * 1. Initializes the core `McpServer` instance (from `@modelcontextprotocol/sdk`) with its identity and capabilities.
5
- * 2. Registers available resources and tools, making them discoverable and usable by clients.
6
- * 3. Selects and starts the appropriate communication transport (stdio or Streamable HTTP)
7
- * based on configuration.
8
- * 4. Handles top-level error management during startup.
9
- *
10
- * MCP Specification References:
11
- * - Lifecycle: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/lifecycle.mdx
12
- * - Overview (Capabilities): https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/index.mdx
13
- * - Transports: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/transports.mdx
14
- * @module src/mcp-server/server
15
- */
16
- import { ServerType } from "@hono/node-server";
17
- import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
18
- import { ObsidianRestApiService } from "../services/obsidianRestAPI/index.js";
19
- import { VaultCacheService } from "../services/obsidianRestAPI/vaultCache/index.js";
20
- /**
21
- * Main application entry point. Initializes services and starts the MCP server.
22
- * Orchestrates server startup, transport selection, and top-level error handling.
23
- *
24
- * MCP Spec Relevance:
25
- * - Manages server startup, leading to a server ready for MCP messages.
26
- * - Handles critical startup failures, ensuring appropriate process exit.
27
- *
28
- * @param {ObsidianRestApiService} obsidianService - The shared Obsidian REST API service instance, instantiated by the caller (e.g., index.ts).
29
- * @param {VaultCacheService | undefined} vaultCacheService - The shared Vault Cache service instance, instantiated by the caller (e.g., index.ts).
30
- * @returns {Promise<void | McpServer>} For 'stdio', resolves with `McpServer`. For 'http', runs indefinitely.
31
- * Rejects on critical failure, leading to process exit.
32
- */
33
- export declare function initializeAndStartServer(obsidianService: ObsidianRestApiService, vaultCacheService: VaultCacheService | undefined): Promise<void | McpServer | ServerType>;
@@ -1,211 +0,0 @@
1
- /**
2
- * @fileoverview Main entry point for the MCP (Model Context Protocol) server.
3
- * This file orchestrates the server's lifecycle:
4
- * 1. Initializes the core `McpServer` instance (from `@modelcontextprotocol/sdk`) with its identity and capabilities.
5
- * 2. Registers available resources and tools, making them discoverable and usable by clients.
6
- * 3. Selects and starts the appropriate communication transport (stdio or Streamable HTTP)
7
- * based on configuration.
8
- * 4. Handles top-level error management during startup.
9
- *
10
- * MCP Specification References:
11
- * - Lifecycle: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/lifecycle.mdx
12
- * - Overview (Capabilities): https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/index.mdx
13
- * - Transports: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/main/docs/specification/2025-03-26/basic/transports.mdx
14
- * @module src/mcp-server/server
15
- */
16
- import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
17
- // Import validated configuration and environment details.
18
- import { config, environment } from "../config/index.js";
19
- // Import core utilities: ErrorHandler, logger, requestContextService.
20
- import { ErrorHandler, logger, requestContextService } from "../utils/index.js";
21
- // Import registration functions for specific resources and tools.
22
- import { registerObsidianDeleteNoteTool } from "./tools/obsidianDeleteNoteTool/index.js";
23
- import { registerObsidianGlobalSearchTool } from "./tools/obsidianGlobalSearchTool/index.js";
24
- import { registerObsidianListNotesTool } from "./tools/obsidianListNotesTool/index.js";
25
- import { registerObsidianReadNoteTool } from "./tools/obsidianReadNoteTool/index.js";
26
- import { registerObsidianSearchReplaceTool } from "./tools/obsidianSearchReplaceTool/index.js";
27
- import { registerObsidianUpdateNoteTool } from "./tools/obsidianUpdateNoteTool/index.js";
28
- import { registerObsidianManageFrontmatterTool } from "./tools/obsidianManageFrontmatterTool/index.js";
29
- import { registerObsidianManageTagsTool } from "./tools/obsidianManageTagsTool/index.js";
30
- // Import transport setup functions.
31
- import { startHttpTransport } from "./transports/httpTransport.js";
32
- import { connectStdioTransport } from "./transports/stdioTransport.js";
33
- /**
34
- * Creates and configures a new instance of the `McpServer`.
35
- *
36
- * This function is central to defining the server's identity and functionality
37
- * as presented to connecting clients during the MCP initialization phase.
38
- * It uses pre-instantiated shared services like Obsidian API and Vault Cache.
39
- *
40
- * MCP Spec Relevance:
41
- * - Server Identity (`serverInfo`): The `name` and `version` provided here are part
42
- * of the `ServerInformation` object returned in the `InitializeResult` message.
43
- * - Capabilities Declaration: Declares supported features (logging, dynamic resources/tools).
44
- * - Resource/Tool Registration: Calls registration functions, passing necessary service instances.
45
- *
46
- * Design Note: This factory is called once for 'stdio' transport and per session for 'http' transport.
47
- *
48
- * @param {ObsidianRestApiService} obsidianService - The shared Obsidian REST API service instance.
49
- * @param {VaultCacheService | undefined} vaultCacheService - The shared Vault Cache service instance, which may be undefined if disabled.
50
- * @returns {Promise<McpServer>} A promise resolving with the configured `McpServer` instance.
51
- * @throws {Error} If any resource or tool registration fails.
52
- * @private
53
- */
54
- async function createMcpServerInstance(obsidianService, vaultCacheService) {
55
- const context = requestContextService.createRequestContext({
56
- operation: "createMcpServerInstance",
57
- });
58
- logger.info("Initializing MCP server instance with shared services", context);
59
- requestContextService.configure({
60
- appName: config.mcpServerName,
61
- appVersion: config.mcpServerVersion,
62
- environment,
63
- });
64
- logger.debug("Instantiating McpServer with capabilities", {
65
- ...context,
66
- serverInfo: {
67
- name: config.mcpServerName,
68
- version: config.mcpServerVersion,
69
- },
70
- capabilities: {
71
- logging: {},
72
- resources: { listChanged: true },
73
- tools: { listChanged: true },
74
- },
75
- });
76
- const server = new McpServer({ name: config.mcpServerName, version: config.mcpServerVersion }, {
77
- capabilities: {
78
- logging: {}, // Server can receive logging/setLevel and send notifications/message
79
- resources: { listChanged: true }, // Server supports dynamic resource lists
80
- tools: { listChanged: true }, // Server supports dynamic tool lists
81
- },
82
- });
83
- try {
84
- logger.debug("Registering resources and tools using shared services...", context);
85
- // Register all tools, passing the vaultCacheService which may be undefined
86
- await registerObsidianListNotesTool(server, obsidianService);
87
- await registerObsidianReadNoteTool(server, obsidianService);
88
- await registerObsidianDeleteNoteTool(server, obsidianService, vaultCacheService);
89
- if (vaultCacheService) {
90
- await registerObsidianGlobalSearchTool(server, obsidianService, vaultCacheService);
91
- }
92
- else {
93
- logger.warning("Skipping registration of 'obsidian_global_search' because the Vault Cache Service is disabled.", context);
94
- }
95
- await registerObsidianSearchReplaceTool(server, obsidianService, vaultCacheService);
96
- await registerObsidianUpdateNoteTool(server, obsidianService, vaultCacheService);
97
- await registerObsidianManageFrontmatterTool(server, obsidianService, vaultCacheService);
98
- await registerObsidianManageTagsTool(server, obsidianService, vaultCacheService);
99
- logger.info("Resources and tools registered successfully", context);
100
- if (vaultCacheService) {
101
- logger.info("Triggering background vault cache build (if not already built/building)...", context);
102
- // Intentionally not awaiting this promise to allow server startup to proceed.
103
- // Errors are logged within the catch block.
104
- vaultCacheService.buildVaultCache().catch((cacheBuildError) => {
105
- logger.error("Error occurred during background vault cache build", {
106
- ...context, // Use the initial context for correlation
107
- subOperation: "BackgroundVaultCacheBuild", // Add sub-operation for clarity
108
- error: cacheBuildError instanceof Error
109
- ? cacheBuildError.message
110
- : String(cacheBuildError),
111
- stack: cacheBuildError instanceof Error
112
- ? cacheBuildError.stack
113
- : undefined,
114
- });
115
- });
116
- }
117
- }
118
- catch (err) {
119
- logger.error("Failed to register resources/tools", {
120
- ...context,
121
- error: err instanceof Error ? err.message : String(err),
122
- stack: err instanceof Error ? err.stack : undefined,
123
- });
124
- throw err; // Re-throw to be caught by the caller (e.g., startTransport)
125
- }
126
- return server;
127
- }
128
- /**
129
- * Selects, sets up, and starts the appropriate MCP transport layer based on configuration.
130
- * This function acts as the bridge between the core server logic and the communication channel.
131
- * It now accepts shared service instances to pass them down the chain.
132
- *
133
- * MCP Spec Relevance:
134
- * - Transport Selection: Uses `config.mcpTransportType` ('stdio' or 'http').
135
- * - Transport Connection: Calls dedicated functions for chosen transport.
136
- * - Server Instance Lifecycle: Single instance for 'stdio', per-session for 'http'.
137
- *
138
- * @param {ObsidianRestApiService} obsidianService - The shared Obsidian REST API service instance.
139
- * @param {VaultCacheService | undefined} vaultCacheService - The shared Vault Cache service instance.
140
- * @returns {Promise<McpServer | void>} Resolves with the `McpServer` instance for 'stdio', or `void` for 'http'.
141
- * @throws {Error} If the configured transport type is unsupported or if transport setup fails.
142
- * @private
143
- */
144
- async function startTransport(obsidianService, vaultCacheService) {
145
- const transportType = config.mcpTransportType;
146
- const context = requestContextService.createRequestContext({
147
- operation: "startTransport",
148
- transport: transportType,
149
- });
150
- logger.info(`Starting transport: ${transportType}`, context);
151
- if (transportType === "http") {
152
- logger.debug("Delegating to startHttpTransport with a factory for McpServer instances...", context);
153
- // For HTTP, startHttpTransport manages its own lifecycle and server instances per session.
154
- // It needs a factory function to create new McpServer instances, passing along the shared services.
155
- const mcpServerFactory = async () => createMcpServerInstance(obsidianService, vaultCacheService);
156
- const httpServerInstance = await startHttpTransport(mcpServerFactory, context);
157
- return httpServerInstance; // Return the http.Server instance.
158
- }
159
- if (transportType === "stdio") {
160
- logger.debug("Creating single McpServer instance for stdio transport using shared services...", context);
161
- const server = await createMcpServerInstance(obsidianService, vaultCacheService);
162
- logger.debug("Delegating to connectStdioTransport...", context);
163
- await connectStdioTransport(server, context);
164
- return server; // Return the single server instance for stdio.
165
- }
166
- // Should not be reached if config validation is effective.
167
- logger.fatal(`Unsupported transport type configured: ${transportType}`, context);
168
- throw new Error(`Unsupported transport type: ${transportType}. Must be 'stdio' or 'http'.`);
169
- }
170
- /**
171
- * Main application entry point. Initializes services and starts the MCP server.
172
- * Orchestrates server startup, transport selection, and top-level error handling.
173
- *
174
- * MCP Spec Relevance:
175
- * - Manages server startup, leading to a server ready for MCP messages.
176
- * - Handles critical startup failures, ensuring appropriate process exit.
177
- *
178
- * @param {ObsidianRestApiService} obsidianService - The shared Obsidian REST API service instance, instantiated by the caller (e.g., index.ts).
179
- * @param {VaultCacheService | undefined} vaultCacheService - The shared Vault Cache service instance, instantiated by the caller (e.g., index.ts).
180
- * @returns {Promise<void | McpServer>} For 'stdio', resolves with `McpServer`. For 'http', runs indefinitely.
181
- * Rejects on critical failure, leading to process exit.
182
- */
183
- export async function initializeAndStartServer(obsidianService, vaultCacheService) {
184
- const context = requestContextService.createRequestContext({
185
- operation: "initializeAndStartServer",
186
- });
187
- logger.info("MCP Server initialization sequence started (services provided).", context);
188
- try {
189
- // Services are now provided by the caller (e.g., index.ts)
190
- logger.debug("Using provided shared services (ObsidianRestApiService, VaultCacheService).", context);
191
- // Initiate the transport setup based on configuration, passing shared services.
192
- const result = await startTransport(obsidianService, vaultCacheService);
193
- logger.info("MCP Server initialization sequence completed successfully.", context);
194
- return result;
195
- }
196
- catch (err) {
197
- logger.fatal("Critical error during MCP server initialization.", {
198
- ...context,
199
- error: err instanceof Error ? err.message : String(err),
200
- stack: err instanceof Error ? err.stack : undefined,
201
- });
202
- // Ensure the error is handled by our centralized handler, which might log more details or perform cleanup.
203
- ErrorHandler.handleError(err, {
204
- operation: "initializeAndStartServer", // More specific operation
205
- context: context, // Pass the existing context
206
- critical: true, // This is a critical failure
207
- });
208
- logger.info("Exiting process due to critical initialization error.", context);
209
- process.exit(1); // Exit with a non-zero code to indicate failure.
210
- }
211
- }
@@ -1,12 +0,0 @@
1
- /**
2
- * @fileoverview Barrel file for the 'obsidian_delete_note' MCP tool.
3
- *
4
- * This file serves as the public entry point for the obsidian_delete_note tool module.
5
- * It re-exports the primary registration function (`registerObsidianDeleteNoteTool`)
6
- * from the './registration.js' module. This pattern simplifies imports for consumers
7
- * of the tool, allowing them to import necessary components from a single location.
8
- *
9
- * Consumers (like the main server setup) should import the registration function
10
- * from this file to integrate the tool into the MCP server instance.
11
- */
12
- export { registerObsidianDeleteNoteTool } from "./registration.js";
@@ -1,12 +0,0 @@
1
- /**
2
- * @fileoverview Barrel file for the 'obsidian_delete_note' MCP tool.
3
- *
4
- * This file serves as the public entry point for the obsidian_delete_note tool module.
5
- * It re-exports the primary registration function (`registerObsidianDeleteNoteTool`)
6
- * from the './registration.js' module. This pattern simplifies imports for consumers
7
- * of the tool, allowing them to import necessary components from a single location.
8
- *
9
- * Consumers (like the main server setup) should import the registration function
10
- * from this file to integrate the tool into the MCP server instance.
11
- */
12
- export { registerObsidianDeleteNoteTool } from "./registration.js";
@@ -1,51 +0,0 @@
1
- import { z } from "zod";
2
- import { ObsidianRestApiService, VaultCacheService } from "../../../services/obsidianRestAPI/index.js";
3
- import { RequestContext } from "../../../utils/index.js";
4
- /**
5
- * Zod schema for validating the input parameters of the 'obsidian_delete_note' tool.
6
- */
7
- export declare const ObsidianDeleteNoteInputSchema: z.ZodObject<{
8
- /**
9
- * The vault-relative path to the file to be permanently deleted.
10
- * Must include the file extension (e.g., "Old Notes/Obsolete File.md").
11
- * The tool first attempts a case-sensitive match. If not found, it attempts
12
- * a case-insensitive fallback search within the same directory.
13
- */
14
- filePath: z.ZodString;
15
- }, "strip", z.ZodTypeAny, {
16
- filePath: string;
17
- }, {
18
- filePath: string;
19
- }>;
20
- /**
21
- * TypeScript type inferred from the input schema (`ObsidianDeleteNoteInputSchema`).
22
- * Represents the validated input parameters used within the core processing logic.
23
- */
24
- export type ObsidianDeleteNoteInput = z.infer<typeof ObsidianDeleteNoteInputSchema>;
25
- /**
26
- * Defines the structure of the successful response returned by the `processObsidianDeleteNote` function.
27
- * This object is typically serialized to JSON and sent back to the client.
28
- */
29
- export interface ObsidianDeleteNoteResponse {
30
- /** Indicates whether the deletion operation was successful. */
31
- success: boolean;
32
- /** A human-readable message confirming the deletion and specifying the path used. */
33
- message: string;
34
- }
35
- /**
36
- * Processes the core logic for deleting a file from the Obsidian vault.
37
- *
38
- * It attempts to delete the file using the provided path (case-sensitive first).
39
- * If that fails with a 'NOT_FOUND' error, it attempts a case-insensitive fallback:
40
- * it lists the directory, finds a unique case-insensitive match for the filename,
41
- * and retries the deletion with the corrected path.
42
- *
43
- * @param {ObsidianDeleteNoteInput} params - The validated input parameters.
44
- * @param {RequestContext} context - The request context for logging and correlation.
45
- * @param {ObsidianRestApiService} obsidianService - An instance of the Obsidian REST API service.
46
- * @returns {Promise<ObsidianDeleteNoteResponse>} A promise resolving to the structured success response
47
- * containing a confirmation message.
48
- * @throws {McpError} Throws an McpError if the file cannot be found (even with fallback),
49
- * if there's an ambiguous fallback match, or if any other API interaction fails.
50
- */
51
- export declare const processObsidianDeleteNote: (params: ObsidianDeleteNoteInput, context: RequestContext, obsidianService: ObsidianRestApiService, vaultCacheService: VaultCacheService | undefined) => Promise<ObsidianDeleteNoteResponse>;