Spaces:
Sleeping
Sleeping
File size: 19,040 Bytes
2510c5e |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 |
{
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "MCP Tools for Obsidian-Like Docs Viewer",
"description": "FastMCP tool definitions for multi-tenant documentation viewer with JSON Schema validation (Pydantic)",
"tools": [
{
"name": "list_notes",
"title": "List Notes",
"description": "List all notes in the authenticated user's vault with optional folder filtering. Returns lightweight summaries with path, title, and last modified timestamp.",
"inputSchema": {
"type": "object",
"properties": {
"folder": {
"type": "string",
"description": "Optional folder path to filter notes (e.g., 'api' or 'guides/tutorials'). If omitted, returns all notes in the vault.",
"maxLength": 256,
"examples": ["api", "guides/tutorials", ""]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "array",
"description": "Array of note summaries, sorted by most recently updated first",
"items": {
"type": "object",
"required": ["path", "title", "last_modified"],
"properties": {
"path": {
"type": "string",
"description": "Relative path to vault root (includes .md extension)",
"examples": ["api/design.md", "README.md"]
},
"title": {
"type": "string",
"description": "Display title (from frontmatter, H1, or filename)",
"examples": ["API Design", "README"]
},
"last_modified": {
"type": "string",
"format": "date-time",
"description": "Last modification timestamp (ISO 8601)",
"examples": ["2025-01-15T14:30:00Z"]
}
}
},
"examples": [
[
{
"path": "api/design.md",
"title": "API Design",
"last_modified": "2025-01-15T14:30:00Z"
},
{
"path": "api/endpoints.md",
"title": "API Endpoints",
"last_modified": "2025-01-14T09:15:00Z"
}
]
]
}
},
{
"name": "read_note",
"title": "Read Note",
"description": "Retrieve full note content including metadata (frontmatter), body (markdown), and system-managed fields (version, timestamps). Use this to access existing documentation.",
"inputSchema": {
"type": "object",
"required": ["path"],
"properties": {
"path": {
"type": "string",
"description": "Relative path to vault root (includes .md extension, e.g., 'api/design.md')",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^/].*\\.md$",
"examples": ["api/design.md", "README.md", "guides/setup.md"]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"required": ["path", "title", "metadata", "body"],
"properties": {
"path": {
"type": "string",
"description": "Note path (echo of input)",
"examples": ["api/design.md"]
},
"title": {
"type": "string",
"description": "Display title",
"examples": ["API Design"]
},
"metadata": {
"type": "object",
"description": "Frontmatter key-value pairs (arbitrary structure)",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"project": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"updated": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": true,
"examples": [
{
"tags": ["backend", "api"],
"project": "auth-service"
}
]
},
"body": {
"type": "string",
"description": "Markdown content (excluding frontmatter YAML)",
"examples": ["# API Design\n\nThis document describes the API architecture...\n\n## Endpoints\n\nSee [[Endpoints]] for details."]
}
},
"examples": [
{
"path": "api/design.md",
"title": "API Design",
"metadata": {
"tags": ["backend", "api"],
"project": "auth-service"
},
"body": "# API Design\n\nThis document describes the API architecture..."
}
]
}
},
{
"name": "write_note",
"title": "Write Note",
"description": "Create a new note or update an existing note. Automatically manages version, created/updated timestamps, and index updates. Uses last-write-wins strategy (no version conflict detection for MCP writes).",
"inputSchema": {
"type": "object",
"required": ["path", "body"],
"properties": {
"path": {
"type": "string",
"description": "Relative path to vault root (includes .md extension). Must not contain '..', use Unix separators (/), and be relative (no leading /).",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^/].*\\.md$",
"examples": ["api/design.md", "README.md", "guides/new-feature.md"]
},
"title": {
"type": "string",
"description": "Optional title override (if omitted, will be extracted from frontmatter or first H1 heading in body)",
"examples": ["API Design", "New Feature Guide"]
},
"metadata": {
"type": "object",
"description": "Optional frontmatter metadata (arbitrary key-value pairs). Common fields: tags (array), project (string), etc.",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tag names for categorization"
},
"project": {
"type": "string",
"description": "Project identifier"
}
},
"additionalProperties": true,
"examples": [
{
"tags": ["backend", "api"],
"project": "auth-service"
}
]
},
"body": {
"type": "string",
"description": "Markdown content (max 1 MiB UTF-8). Can contain wikilinks using [[link text]] syntax.",
"maxLength": 1048576,
"examples": ["# API Design\n\nThis document describes the API architecture...\n\n## Related\n\nSee [[Endpoints]] for endpoint details."]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"required": ["status", "path"],
"properties": {
"status": {
"type": "string",
"enum": ["ok"],
"description": "Operation status"
},
"path": {
"type": "string",
"description": "Path of the created/updated note",
"examples": ["api/design.md"]
}
},
"examples": [
{
"status": "ok",
"path": "api/design.md"
}
]
}
},
{
"name": "delete_note",
"title": "Delete Note",
"description": "Permanently delete a note from the vault and remove it from all indices (full-text, tags, links). Any wikilinks referencing this note will become unresolved.",
"inputSchema": {
"type": "object",
"required": ["path"],
"properties": {
"path": {
"type": "string",
"description": "Relative path to vault root (includes .md extension)",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^/].*\\.md$",
"examples": ["api/design.md", "obsolete/old-doc.md"]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "object",
"required": ["status"],
"properties": {
"status": {
"type": "string",
"enum": ["ok"],
"description": "Operation status"
}
},
"examples": [
{
"status": "ok"
}
]
}
},
{
"name": "search_notes",
"title": "Search Notes",
"description": "Full-text search across all notes in the user's vault. Results are ranked using: (3 * title_matches) + (1 * body_matches) + recency_bonus. Returns snippets with highlighted matches.",
"inputSchema": {
"type": "object",
"required": ["query"],
"properties": {
"query": {
"type": "string",
"description": "Search query (tokenized, case-insensitive). Supports simple keyword search with automatic stemming (e.g., 'running' matches 'run').",
"minLength": 1,
"maxLength": 256,
"examples": ["authentication", "API design", "database schema"]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "array",
"description": "Search results sorted by relevance score (descending). Limited to top 50 results.",
"maxItems": 50,
"items": {
"type": "object",
"required": ["path", "title", "snippet"],
"properties": {
"path": {
"type": "string",
"description": "Note path",
"examples": ["api/auth.md"]
},
"title": {
"type": "string",
"description": "Note title",
"examples": ["Authentication Flow"]
},
"snippet": {
"type": "string",
"description": "Highlighted excerpt from body (max ~200 chars, with <mark> tags around matches)",
"examples": ["...describes the <mark>authentication</mark> process using JWT tokens..."]
}
}
},
"examples": [
[
{
"path": "api/auth.md",
"title": "Authentication Flow",
"snippet": "...describes the <mark>authentication</mark> process using JWT tokens..."
},
{
"path": "guides/setup.md",
"title": "Setup Guide",
"snippet": "...configure <mark>authentication</mark> settings in the config file..."
}
]
]
}
},
{
"name": "get_backlinks",
"title": "Get Backlinks",
"description": "Get all notes that reference the specified note via wikilinks (e.g., [[Note Name]]). Useful for discovering related documentation and navigation.",
"inputSchema": {
"type": "object",
"required": ["path"],
"properties": {
"path": {
"type": "string",
"description": "Relative path to vault root (includes .md extension)",
"minLength": 1,
"maxLength": 256,
"pattern": "^[^/].*\\.md$",
"examples": ["api/design.md", "README.md"]
}
},
"additionalProperties": false
},
"outputSchema": {
"type": "array",
"description": "Array of notes that link to the target note, sorted by most recently updated first",
"items": {
"type": "object",
"required": ["path", "title"],
"properties": {
"path": {
"type": "string",
"description": "Path of the linking note",
"examples": ["guides/architecture.md"]
},
"title": {
"type": "string",
"description": "Title of the linking note",
"examples": ["Architecture Overview"]
}
}
},
"examples": [
[
{
"path": "guides/architecture.md",
"title": "Architecture Overview"
},
{
"path": "api/endpoints.md",
"title": "API Endpoints"
}
]
]
}
},
{
"name": "get_tags",
"title": "Get Tags",
"description": "List all tags used across the user's vault with note counts. Tags are extracted from frontmatter 'tags' field and normalized (lowercase).",
"inputSchema": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"outputSchema": {
"type": "array",
"description": "Array of tags sorted by count (descending)",
"items": {
"type": "object",
"required": ["tag", "count"],
"properties": {
"tag": {
"type": "string",
"description": "Tag name (lowercase, normalized)",
"examples": ["backend", "api", "frontend"]
},
"count": {
"type": "integer",
"minimum": 0,
"description": "Number of notes with this tag",
"examples": [15, 12, 8]
}
}
},
"examples": [
[
{
"tag": "backend",
"count": 15
},
{
"tag": "api",
"count": 12
},
{
"tag": "frontend",
"count": 8
}
]
]
}
}
],
"authentication": {
"type": "bearer",
"description": "MCP HTTP transport requires Bearer JWT token via 'auth' parameter. STDIO transport (local mode) does not require authentication.",
"tokenSource": "POST /api/tokens",
"tokenExpiration": "90 days"
},
"errors": {
"description": "All MCP tools follow FastMCP error handling conventions. Common error scenarios:",
"errorCodes": [
{
"code": "AUTHENTICATION_REQUIRED",
"description": "Missing or invalid JWT token (HTTP transport only)",
"httpStatus": 401
},
{
"code": "PERMISSION_DENIED",
"description": "Vault note limit exceeded (5,000 notes) or path traversal attempt",
"httpStatus": 403
},
{
"code": "NOT_FOUND",
"description": "Note path does not exist in vault",
"httpStatus": 404
},
{
"code": "VALIDATION_ERROR",
"description": "Invalid input parameters (e.g., path format, content size)",
"httpStatus": 400,
"details": {
"invalidPath": "Path must end with .md, not contain '..' or '\\', and be relative",
"payloadTooLarge": "Note body exceeds 1 MiB UTF-8 text limit",
"emptyQuery": "Search query must be at least 1 character"
}
},
{
"code": "INTERNAL_ERROR",
"description": "Unexpected server error (filesystem, database, etc.)",
"httpStatus": 500
}
]
},
"examples": {
"description": "Common usage patterns for AI agents via MCP",
"scenarios": [
{
"name": "Create documentation structure",
"description": "AI agent creates initial project documentation with organized folders",
"steps": [
{
"tool": "write_note",
"input": {
"path": "README.md",
"title": "Project Overview",
"metadata": {
"tags": ["overview", "documentation"]
},
"body": "# Project Overview\n\nWelcome to the project.\n\n## Structure\n\n- [[API Documentation]] - API design and endpoints\n- [[Guides]] - User guides and tutorials"
}
},
{
"tool": "write_note",
"input": {
"path": "api/README.md",
"title": "API Documentation",
"metadata": {
"tags": ["api", "backend"]
},
"body": "# API Documentation\n\nSee:\n- [[Authentication]] for auth flows\n- [[Endpoints]] for endpoint specs"
}
}
]
},
{
"name": "Update documentation with search",
"description": "AI agent searches for existing docs before updating",
"steps": [
{
"tool": "search_notes",
"input": {
"query": "authentication"
},
"output": [
{
"path": "api/auth.md",
"title": "Authentication Flow",
"snippet": "...JWT token-based authentication..."
}
]
},
{
"tool": "read_note",
"input": {
"path": "api/auth.md"
}
},
{
"tool": "write_note",
"input": {
"path": "api/auth.md",
"body": "# Authentication Flow\n\n[Updated content with new OAuth section...]"
}
}
]
},
{
"name": "Discover related documentation",
"description": "AI agent uses backlinks to find related docs",
"steps": [
{
"tool": "get_backlinks",
"input": {
"path": "api/design.md"
},
"output": [
{
"path": "guides/architecture.md",
"title": "Architecture Overview"
},
{
"path": "api/endpoints.md",
"title": "API Endpoints"
}
]
},
{
"tool": "read_note",
"input": {
"path": "guides/architecture.md"
}
}
]
}
]
},
"validation": {
"description": "Input validation rules enforced by FastMCP/Pydantic",
"rules": {
"notePath": {
"pattern": "^[^/].*\\.md$",
"minLength": 1,
"maxLength": 256,
"mustNotContain": ["..", "\\"],
"mustEndWith": ".md",
"invalidChars": ["<", ">", ":", "\"", "|", "?", "*"]
},
"noteBody": {
"maxLength": 1048576,
"encoding": "UTF-8"
},
"searchQuery": {
"minLength": 1,
"maxLength": 256
},
"folder": {
"maxLength": 256,
"optional": true
},
"metadata": {
"type": "object",
"reservedFields": ["version"],
"tagsFormat": "array of strings"
}
}
}
}
|