joplin-mcp-server 0.1.0__tar.gz → 0.1.2__tar.gz
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.
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/LICENSE.md +21 -21
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/PKG-INFO +51 -50
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/README.md +23 -23
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/pyproject.toml +82 -82
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/setup.cfg +4 -4
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/__init__.py +1 -1
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server/__init__.py +1 -1
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server/entry.py +31 -32
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server/joplin_client.py +39 -39
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server.egg-info/PKG-INFO +51 -50
- joplin_mcp_server-0.1.2/src/joplin_mcp_server.egg-info/requires.txt +5 -0
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/tests/test_dummy.py +2 -2
- joplin_mcp_server-0.1.0/src/joplin_mcp_server.egg-info/requires.txt +0 -2
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server.egg-info/SOURCES.txt +0 -0
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server.egg-info/dependency_links.txt +0 -0
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server.egg-info/entry_points.txt +0 -0
- {joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server.egg-info/top_level.txt +0 -0
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c)
|
|
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.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Zeyang Lin
|
|
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.
|
|
@@ -1,50 +1,51 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: joplin-mcp-server
|
|
3
|
-
Version: 0.1.
|
|
4
|
-
Summary: A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools. Built with Python, uv, httpx, and FastMCP.
|
|
5
|
-
Author-email: Zeyang Lin <4020306+linzeyang@users.noreply.github.com>
|
|
6
|
-
License-Expression: MIT
|
|
7
|
-
Project-URL: Homepage, https://github.com/linzeyang/joplin-mcp-server
|
|
8
|
-
Project-URL: Documentation, https://github.com/linzeyang/joplin-mcp-server#readme
|
|
9
|
-
Keywords: joplin,mcp,server,rest api,notes,python
|
|
10
|
-
Classifier: Programming Language :: Python :: 3
|
|
11
|
-
Classifier: Programming Language :: Python :: 3.
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.
|
|
14
|
-
Classifier:
|
|
15
|
-
Classifier: Operating System ::
|
|
16
|
-
Classifier: Operating System ::
|
|
17
|
-
Classifier:
|
|
18
|
-
Classifier:
|
|
19
|
-
Classifier:
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
Requires-Dist:
|
|
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
|
-
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: joplin-mcp-server
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools. Built with Python, uv, httpx, and FastMCP.
|
|
5
|
+
Author-email: Zeyang Lin <4020306+linzeyang@users.noreply.github.com>
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/linzeyang/joplin-mcp-server
|
|
8
|
+
Project-URL: Documentation, https://github.com/linzeyang/joplin-mcp-server#readme
|
|
9
|
+
Keywords: joplin,mcp,server,rest api,notes,python
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
14
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
15
|
+
Classifier: Operating System :: MacOS
|
|
16
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
17
|
+
Classifier: Intended Audience :: Developers
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
|
|
19
|
+
Classifier: Development Status :: 3 - Alpha
|
|
20
|
+
Requires-Python: <3.15,>=3.12
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE.md
|
|
23
|
+
Requires-Dist: fastmcp<3
|
|
24
|
+
Requires-Dist: httpx<1
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: pytest<10,>=9.0; extra == "dev"
|
|
27
|
+
Dynamic: license-file
|
|
28
|
+
|
|
29
|
+
# joplin-mcp-server
|
|
30
|
+
|
|
31
|
+
A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools.
|
|
32
|
+
|
|
33
|
+
- **Tech stack:** Python, uv, httpx, FastMCP
|
|
34
|
+
- **License:** MIT
|
|
35
|
+
|
|
36
|
+
## Features
|
|
37
|
+
- Bridges Joplin's REST API to MCP tools
|
|
38
|
+
- Designed for extensibility and integration
|
|
39
|
+
|
|
40
|
+
## Quick Start
|
|
41
|
+
1. Clone this repository
|
|
42
|
+
2. Set up a Python 3.12+ environment (recommended: `uv`)
|
|
43
|
+
3. Install dependencies: `uv sync`
|
|
44
|
+
4. Run the server: `uvx joplin-mcp-server`
|
|
45
|
+
|
|
46
|
+
## Project Structure
|
|
47
|
+
- `src/joplin_mcp_server/` — Main package code
|
|
48
|
+
- `specs/` — API documentation and references
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
MIT
|
|
@@ -1,23 +1,23 @@
|
|
|
1
|
-
# joplin-mcp-server
|
|
2
|
-
|
|
3
|
-
A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools.
|
|
4
|
-
|
|
5
|
-
- **Tech stack:** Python, uv, httpx, FastMCP
|
|
6
|
-
- **License:** MIT
|
|
7
|
-
|
|
8
|
-
## Features
|
|
9
|
-
- Bridges Joplin's REST API to MCP tools
|
|
10
|
-
- Designed for extensibility and integration
|
|
11
|
-
|
|
12
|
-
## Quick Start
|
|
13
|
-
1. Clone this repository
|
|
14
|
-
2. Set up a Python 3.
|
|
15
|
-
3. Install dependencies: `uv
|
|
16
|
-
4. Run the server: `uvx joplin-mcp-server`
|
|
17
|
-
|
|
18
|
-
## Project Structure
|
|
19
|
-
- `src/joplin_mcp_server/` — Main package code
|
|
20
|
-
- `specs/` — API documentation and references
|
|
21
|
-
|
|
22
|
-
## License
|
|
23
|
-
MIT
|
|
1
|
+
# joplin-mcp-server
|
|
2
|
+
|
|
3
|
+
A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools.
|
|
4
|
+
|
|
5
|
+
- **Tech stack:** Python, uv, httpx, FastMCP
|
|
6
|
+
- **License:** MIT
|
|
7
|
+
|
|
8
|
+
## Features
|
|
9
|
+
- Bridges Joplin's REST API to MCP tools
|
|
10
|
+
- Designed for extensibility and integration
|
|
11
|
+
|
|
12
|
+
## Quick Start
|
|
13
|
+
1. Clone this repository
|
|
14
|
+
2. Set up a Python 3.12+ environment (recommended: `uv`)
|
|
15
|
+
3. Install dependencies: `uv sync`
|
|
16
|
+
4. Run the server: `uvx joplin-mcp-server`
|
|
17
|
+
|
|
18
|
+
## Project Structure
|
|
19
|
+
- `src/joplin_mcp_server/` — Main package code
|
|
20
|
+
- `specs/` — API documentation and references
|
|
21
|
+
|
|
22
|
+
## License
|
|
23
|
+
MIT
|
|
@@ -1,82 +1,82 @@
|
|
|
1
|
-
[project]
|
|
2
|
-
name = "joplin-mcp-server"
|
|
3
|
-
version = "0.1.
|
|
4
|
-
description = "A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools. Built with Python, uv, httpx, and FastMCP."
|
|
5
|
-
readme = "README.md"
|
|
6
|
-
requires-python = ">=3.
|
|
7
|
-
dependencies = ["fastmcp
|
|
8
|
-
license = "MIT"
|
|
9
|
-
authors = [
|
|
10
|
-
{ name = "Zeyang Lin", email = "4020306+linzeyang@users.noreply.github.com" },
|
|
11
|
-
]
|
|
12
|
-
keywords = ["joplin", "mcp", "server", "rest api", "notes", "python"]
|
|
13
|
-
classifiers = [
|
|
14
|
-
"Programming Language :: Python :: 3",
|
|
15
|
-
"Programming Language :: Python :: 3.
|
|
16
|
-
"Programming Language :: Python :: 3.
|
|
17
|
-
"Programming Language :: Python :: 3.
|
|
18
|
-
"
|
|
19
|
-
"Operating System ::
|
|
20
|
-
"Operating System ::
|
|
21
|
-
"
|
|
22
|
-
"
|
|
23
|
-
"
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
[
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
build-
|
|
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
|
-
[tool.ty.
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
[tool.ty.terminal]
|
|
82
|
-
output-format = "full"
|
|
1
|
+
[project]
|
|
2
|
+
name = "joplin-mcp-server"
|
|
3
|
+
version = "0.1.2"
|
|
4
|
+
description = "A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools. Built with Python, uv, httpx, and FastMCP."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.12,<3.15"
|
|
7
|
+
dependencies = ["fastmcp<3", "httpx<1"]
|
|
8
|
+
license = "MIT"
|
|
9
|
+
authors = [
|
|
10
|
+
{ name = "Zeyang Lin", email = "4020306+linzeyang@users.noreply.github.com" },
|
|
11
|
+
]
|
|
12
|
+
keywords = ["joplin", "mcp", "server", "rest api", "notes", "python"]
|
|
13
|
+
classifiers = [
|
|
14
|
+
"Programming Language :: Python :: 3",
|
|
15
|
+
"Programming Language :: Python :: 3.12",
|
|
16
|
+
"Programming Language :: Python :: 3.13",
|
|
17
|
+
"Programming Language :: Python :: 3.14",
|
|
18
|
+
"Operating System :: POSIX :: Linux",
|
|
19
|
+
"Operating System :: MacOS",
|
|
20
|
+
"Operating System :: Microsoft :: Windows",
|
|
21
|
+
"Intended Audience :: Developers",
|
|
22
|
+
"Topic :: Software Development :: Libraries :: Application Frameworks",
|
|
23
|
+
"Development Status :: 3 - Alpha",
|
|
24
|
+
]
|
|
25
|
+
|
|
26
|
+
[project.optional-dependencies]
|
|
27
|
+
dev = ["pytest>=9.0,<10"]
|
|
28
|
+
|
|
29
|
+
[project.urls]
|
|
30
|
+
Homepage = "https://github.com/linzeyang/joplin-mcp-server"
|
|
31
|
+
Documentation = "https://github.com/linzeyang/joplin-mcp-server#readme"
|
|
32
|
+
|
|
33
|
+
[project.scripts]
|
|
34
|
+
joplin-mcp-server = "joplin_mcp_server.entry:main"
|
|
35
|
+
|
|
36
|
+
[build-system]
|
|
37
|
+
requires = ["setuptools>=61.0"]
|
|
38
|
+
build-backend = "setuptools.build_meta"
|
|
39
|
+
|
|
40
|
+
[tool.uv]
|
|
41
|
+
# Add uv-specific configuration here if needed
|
|
42
|
+
|
|
43
|
+
[tool.black]
|
|
44
|
+
line-length = 88
|
|
45
|
+
target-version = ['py312']
|
|
46
|
+
|
|
47
|
+
[tool.isort]
|
|
48
|
+
py_version = 312
|
|
49
|
+
profile = "black"
|
|
50
|
+
|
|
51
|
+
[tool.pylint.format]
|
|
52
|
+
max-line-length = "88"
|
|
53
|
+
|
|
54
|
+
[tool.pytest.ini_options]
|
|
55
|
+
minversion = "9.0"
|
|
56
|
+
testpaths = ["./tests/"]
|
|
57
|
+
python_files = ["test_*.py"]
|
|
58
|
+
console_output_style = "count"
|
|
59
|
+
|
|
60
|
+
[tool.ruff]
|
|
61
|
+
src = ["src"]
|
|
62
|
+
line-length = 88
|
|
63
|
+
target-version = "py312"
|
|
64
|
+
output-format = "full"
|
|
65
|
+
|
|
66
|
+
[tool.ruff.lint]
|
|
67
|
+
select = ["B", "C", "E", "F", "I", "Q", "S", "W"]
|
|
68
|
+
ignore = []
|
|
69
|
+
|
|
70
|
+
[tool.ruff.lint.per-file-ignores]
|
|
71
|
+
"__init__.py" = ["F401"]
|
|
72
|
+
"tests/*.py" = ["S"]
|
|
73
|
+
|
|
74
|
+
[tool.ty.environment]
|
|
75
|
+
python-version = "3.12"
|
|
76
|
+
root = ["./src"]
|
|
77
|
+
|
|
78
|
+
[tool.ty.rules]
|
|
79
|
+
missing-argument = "ignore"
|
|
80
|
+
|
|
81
|
+
[tool.ty.terminal]
|
|
82
|
+
output-format = "full"
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
[egg_info]
|
|
2
|
-
tag_build =
|
|
3
|
-
tag_date = 0
|
|
4
|
-
|
|
1
|
+
[egg_info]
|
|
2
|
+
tag_build =
|
|
3
|
+
tag_date = 0
|
|
4
|
+
|
|
@@ -1 +1 @@
|
|
|
1
|
-
# src package marker
|
|
1
|
+
# src package marker
|
|
@@ -1 +1 @@
|
|
|
1
|
-
# joplin_mcp_server package marker
|
|
1
|
+
# joplin_mcp_server package marker
|
|
@@ -1,32 +1,31 @@
|
|
|
1
|
-
"""
|
|
2
|
-
entry.py
|
|
3
|
-
A FastMCP server entry point for listing Joplin folders.
|
|
4
|
-
"""
|
|
5
|
-
|
|
6
|
-
import
|
|
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
|
-
main()
|
|
1
|
+
"""
|
|
2
|
+
entry.py
|
|
3
|
+
A FastMCP server entry point for listing Joplin folders.
|
|
4
|
+
"""
|
|
5
|
+
|
|
6
|
+
import os
|
|
7
|
+
|
|
8
|
+
from fastmcp import FastMCP
|
|
9
|
+
|
|
10
|
+
from .joplin_client import JoplinClient
|
|
11
|
+
|
|
12
|
+
mcp = FastMCP(name="Joplin MCP Server")
|
|
13
|
+
|
|
14
|
+
# Get token from environment variable for security
|
|
15
|
+
JOPLIN_TOKEN = os.environ.get("JOPLIN_TOKEN", "")
|
|
16
|
+
joplin = JoplinClient(base_url="http://localhost:41184", token=JOPLIN_TOKEN)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
@mcp.tool
|
|
20
|
+
async def list_folders() -> dict:
|
|
21
|
+
"""List all Joplin folders (notebooks) using the Joplin API."""
|
|
22
|
+
|
|
23
|
+
return await joplin.get_folders()
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def main():
|
|
27
|
+
mcp.run()
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
if __name__ == "__main__":
|
|
31
|
+
main()
|
|
@@ -1,39 +1,39 @@
|
|
|
1
|
-
"""
|
|
2
|
-
joplin_client.py
|
|
3
|
-
A client for interacting with the Joplin API.
|
|
4
|
-
|
|
5
|
-
This module provides a simple asynchronous client to interact with the Joplin API.
|
|
6
|
-
"""
|
|
7
|
-
|
|
8
|
-
from typing import Any
|
|
9
|
-
|
|
10
|
-
import httpx
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
class JoplinClient:
|
|
14
|
-
"""
|
|
15
|
-
A client for interacting with the Joplin API.
|
|
16
|
-
"""
|
|
17
|
-
|
|
18
|
-
def __init__(
|
|
19
|
-
self, base_url: str = "http://localhost:41184", token: str = ""
|
|
20
|
-
) -> None:
|
|
21
|
-
self.base_url = base_url.rstrip("/")
|
|
22
|
-
self.token = token
|
|
23
|
-
|
|
24
|
-
def _url(self, path: str) -> str:
|
|
25
|
-
sep = "&" if "?" in path else "?"
|
|
26
|
-
return f"{self.base_url}{path}{sep}token={self.token}"
|
|
27
|
-
|
|
28
|
-
async def get_folders(self) -> dict[str, Any]:
|
|
29
|
-
"""
|
|
30
|
-
Fetches the list of folders from the Joplin API.
|
|
31
|
-
|
|
32
|
-
Returns:
|
|
33
|
-
dict[str, Any]: A dictionary containing the folders.
|
|
34
|
-
"""
|
|
35
|
-
|
|
36
|
-
async with httpx.AsyncClient() as client:
|
|
37
|
-
resp = await client.get(self._url("/folders"))
|
|
38
|
-
resp.raise_for_status()
|
|
39
|
-
return resp.json()
|
|
1
|
+
"""
|
|
2
|
+
joplin_client.py
|
|
3
|
+
A client for interacting with the Joplin API.
|
|
4
|
+
|
|
5
|
+
This module provides a simple asynchronous client to interact with the Joplin API.
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
from typing import Any
|
|
9
|
+
|
|
10
|
+
import httpx
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
class JoplinClient:
|
|
14
|
+
"""
|
|
15
|
+
A client for interacting with the Joplin API.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
def __init__(
|
|
19
|
+
self, base_url: str = "http://localhost:41184", token: str = ""
|
|
20
|
+
) -> None:
|
|
21
|
+
self.base_url = base_url.rstrip("/")
|
|
22
|
+
self.token = token
|
|
23
|
+
|
|
24
|
+
def _url(self, path: str) -> str:
|
|
25
|
+
sep = "&" if "?" in path else "?"
|
|
26
|
+
return f"{self.base_url}{path}{sep}token={self.token}"
|
|
27
|
+
|
|
28
|
+
async def get_folders(self) -> dict[str, Any]:
|
|
29
|
+
"""
|
|
30
|
+
Fetches the list of folders from the Joplin API.
|
|
31
|
+
|
|
32
|
+
Returns:
|
|
33
|
+
dict[str, Any]: A dictionary containing the folders.
|
|
34
|
+
"""
|
|
35
|
+
|
|
36
|
+
async with httpx.AsyncClient() as client:
|
|
37
|
+
resp = await client.get(self._url("/folders"))
|
|
38
|
+
resp.raise_for_status()
|
|
39
|
+
return resp.json()
|
|
@@ -1,50 +1,51 @@
|
|
|
1
|
-
Metadata-Version: 2.4
|
|
2
|
-
Name: joplin-mcp-server
|
|
3
|
-
Version: 0.1.
|
|
4
|
-
Summary: A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools. Built with Python, uv, httpx, and FastMCP.
|
|
5
|
-
Author-email: Zeyang Lin <4020306+linzeyang@users.noreply.github.com>
|
|
6
|
-
License-Expression: MIT
|
|
7
|
-
Project-URL: Homepage, https://github.com/linzeyang/joplin-mcp-server
|
|
8
|
-
Project-URL: Documentation, https://github.com/linzeyang/joplin-mcp-server#readme
|
|
9
|
-
Keywords: joplin,mcp,server,rest api,notes,python
|
|
10
|
-
Classifier: Programming Language :: Python :: 3
|
|
11
|
-
Classifier: Programming Language :: Python :: 3.
|
|
12
|
-
Classifier: Programming Language :: Python :: 3.
|
|
13
|
-
Classifier: Programming Language :: Python :: 3.
|
|
14
|
-
Classifier:
|
|
15
|
-
Classifier: Operating System ::
|
|
16
|
-
Classifier: Operating System ::
|
|
17
|
-
Classifier:
|
|
18
|
-
Classifier:
|
|
19
|
-
Classifier:
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
Requires-Dist:
|
|
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
|
-
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: joplin-mcp-server
|
|
3
|
+
Version: 0.1.2
|
|
4
|
+
Summary: A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools. Built with Python, uv, httpx, and FastMCP.
|
|
5
|
+
Author-email: Zeyang Lin <4020306+linzeyang@users.noreply.github.com>
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/linzeyang/joplin-mcp-server
|
|
8
|
+
Project-URL: Documentation, https://github.com/linzeyang/joplin-mcp-server#readme
|
|
9
|
+
Keywords: joplin,mcp,server,rest api,notes,python
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
14
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
15
|
+
Classifier: Operating System :: MacOS
|
|
16
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
17
|
+
Classifier: Intended Audience :: Developers
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
|
|
19
|
+
Classifier: Development Status :: 3 - Alpha
|
|
20
|
+
Requires-Python: <3.15,>=3.12
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE.md
|
|
23
|
+
Requires-Dist: fastmcp<3
|
|
24
|
+
Requires-Dist: httpx<1
|
|
25
|
+
Provides-Extra: dev
|
|
26
|
+
Requires-Dist: pytest<10,>=9.0; extra == "dev"
|
|
27
|
+
Dynamic: license-file
|
|
28
|
+
|
|
29
|
+
# joplin-mcp-server
|
|
30
|
+
|
|
31
|
+
A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools.
|
|
32
|
+
|
|
33
|
+
- **Tech stack:** Python, uv, httpx, FastMCP
|
|
34
|
+
- **License:** MIT
|
|
35
|
+
|
|
36
|
+
## Features
|
|
37
|
+
- Bridges Joplin's REST API to MCP tools
|
|
38
|
+
- Designed for extensibility and integration
|
|
39
|
+
|
|
40
|
+
## Quick Start
|
|
41
|
+
1. Clone this repository
|
|
42
|
+
2. Set up a Python 3.12+ environment (recommended: `uv`)
|
|
43
|
+
3. Install dependencies: `uv sync`
|
|
44
|
+
4. Run the server: `uvx joplin-mcp-server`
|
|
45
|
+
|
|
46
|
+
## Project Structure
|
|
47
|
+
- `src/joplin_mcp_server/` — Main package code
|
|
48
|
+
- `specs/` — API documentation and references
|
|
49
|
+
|
|
50
|
+
## License
|
|
51
|
+
MIT
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
def test_one_plus_two():
|
|
2
|
-
assert 1 + 2 == 3
|
|
1
|
+
def test_one_plus_two():
|
|
2
|
+
assert 1 + 2 == 3
|
{joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server.egg-info/SOURCES.txt
RENAMED
|
File without changes
|
|
File without changes
|
{joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server.egg-info/entry_points.txt
RENAMED
|
File without changes
|
{joplin_mcp_server-0.1.0 → joplin_mcp_server-0.1.2}/src/joplin_mcp_server.egg-info/top_level.txt
RENAMED
|
File without changes
|