@leonardocrdso/obsidian-mcp 1.0.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 +21 -0
- package/README.md +100 -0
- package/build/index.js +19900 -0
- package/package.json +52 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 leonardocrdso
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# @leonardocrdso/obsidian-mcp
|
|
2
|
+
|
|
3
|
+
MCP server para integração com o Obsidian via plugin [Local REST API](https://github.com/coddingtonbear/obsidian-local-rest-api).
|
|
4
|
+
|
|
5
|
+
Cobertura completa da API com **22 tools** organizadas em 5 módulos.
|
|
6
|
+
|
|
7
|
+
## Requisitos
|
|
8
|
+
|
|
9
|
+
- [Obsidian](https://obsidian.md/) com o plugin **Local REST API** instalado e ativo
|
|
10
|
+
- [Bun](https://bun.sh/) (desenvolvimento) ou Node.js 18+ (produção)
|
|
11
|
+
|
|
12
|
+
## Instalação
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install -g @leonardocrdso/obsidian-mcp
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Configuração
|
|
19
|
+
|
|
20
|
+
### Variáveis de ambiente
|
|
21
|
+
|
|
22
|
+
| Variável | Obrigatória | Padrão | Descrição |
|
|
23
|
+
|---|---|---|---|
|
|
24
|
+
| `OBSIDIAN_API_KEY` | Sim | — | API key do plugin Local REST API |
|
|
25
|
+
| `OBSIDIAN_HOST` | Não | `127.0.0.1` | Host do Obsidian |
|
|
26
|
+
| `OBSIDIAN_PORT` | Não | `27124` | Porta do plugin |
|
|
27
|
+
| `OBSIDIAN_PROTOCOL` | Não | `https` | Protocolo (http ou https) |
|
|
28
|
+
|
|
29
|
+
### Claude Code (`settings.json`)
|
|
30
|
+
|
|
31
|
+
```json
|
|
32
|
+
{
|
|
33
|
+
"mcpServers": {
|
|
34
|
+
"obsidian": {
|
|
35
|
+
"command": "npx",
|
|
36
|
+
"args": ["-y", "@leonardocrdso/obsidian-mcp"],
|
|
37
|
+
"env": {
|
|
38
|
+
"OBSIDIAN_API_KEY": "sua-api-key-aqui"
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Desenvolvimento
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
git clone https://github.com/leonardocrdso/obsidian-mcp.git
|
|
49
|
+
cd obsidian-mcp
|
|
50
|
+
bun install
|
|
51
|
+
OBSIDIAN_API_KEY=sua-key bun run dev
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## Tools (22)
|
|
55
|
+
|
|
56
|
+
### Vault (8)
|
|
57
|
+
| Tool | Descrição |
|
|
58
|
+
|---|---|
|
|
59
|
+
| `vaultListFiles` | Lista arquivos e pastas do vault |
|
|
60
|
+
| `vaultGetFile` | Retorna conteúdo de um arquivo |
|
|
61
|
+
| `vaultGetMetadata` | Retorna metadata (frontmatter, tags) |
|
|
62
|
+
| `vaultCreateFile` | Cria ou substitui um arquivo |
|
|
63
|
+
| `vaultAppendContent` | Adiciona conteúdo ao final |
|
|
64
|
+
| `vaultPatchContent` | Insere conteúdo em local específico |
|
|
65
|
+
| `vaultDeleteFile` | Remove um arquivo |
|
|
66
|
+
| `vaultOpenFile` | Abre arquivo no Obsidian |
|
|
67
|
+
|
|
68
|
+
### Commands (2)
|
|
69
|
+
| Tool | Descrição |
|
|
70
|
+
|---|---|
|
|
71
|
+
| `commandsList` | Lista comandos disponíveis |
|
|
72
|
+
| `commandsExecute` | Executa um comando |
|
|
73
|
+
|
|
74
|
+
### Search (2)
|
|
75
|
+
| Tool | Descrição |
|
|
76
|
+
|---|---|
|
|
77
|
+
| `searchSimple` | Busca texto no vault |
|
|
78
|
+
| `searchAdvanced` | Busca com Dataview DQL ou JsonLogic |
|
|
79
|
+
|
|
80
|
+
### Active File (5)
|
|
81
|
+
| Tool | Descrição |
|
|
82
|
+
|---|---|
|
|
83
|
+
| `activeFileGet` | Retorna conteúdo do arquivo ativo |
|
|
84
|
+
| `activeFileUpdate` | Substitui conteúdo do arquivo ativo |
|
|
85
|
+
| `activeFileAppend` | Adiciona conteúdo ao arquivo ativo |
|
|
86
|
+
| `activeFilePatch` | Insere conteúdo em local específico |
|
|
87
|
+
| `activeFileDelete` | Remove o arquivo ativo |
|
|
88
|
+
|
|
89
|
+
### Periodic Notes (5)
|
|
90
|
+
| Tool | Descrição |
|
|
91
|
+
|---|---|
|
|
92
|
+
| `periodicGetNote` | Retorna nota periódica atual |
|
|
93
|
+
| `periodicCreateNote` | Cria/substitui nota periódica |
|
|
94
|
+
| `periodicAppendContent` | Adiciona conteúdo à nota periódica |
|
|
95
|
+
| `periodicPatchContent` | Insere conteúdo em local específico |
|
|
96
|
+
| `periodicDeleteNote` | Remove nota periódica |
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
MIT
|