joplin-mcp-server 0.1.0__py3-none-any.whl

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.
__init__.py ADDED
@@ -0,0 +1 @@
1
+ # src package marker
@@ -0,0 +1 @@
1
+ # joplin_mcp_server package marker
@@ -0,0 +1,32 @@
1
+ """
2
+ entry.py
3
+ A FastMCP server entry point for listing Joplin folders.
4
+ """
5
+
6
+ import asyncio
7
+ import os
8
+
9
+ from fastmcp import FastMCP
10
+
11
+ from .joplin_client import JoplinClient
12
+
13
+ mcp = FastMCP(name="Joplin MCP Server")
14
+
15
+ # Get token from environment variable for security
16
+ JOPLIN_TOKEN = os.environ.get("JOPLIN_TOKEN", "")
17
+ joplin = JoplinClient(base_url="http://localhost:41184", token=JOPLIN_TOKEN)
18
+
19
+
20
+ @mcp.tool
21
+ def list_folders() -> dict:
22
+ """List all Joplin folders (notebooks) using the Joplin API."""
23
+
24
+ return asyncio.run(joplin.get_folders())
25
+
26
+
27
+ def main():
28
+ mcp.run()
29
+
30
+
31
+ if __name__ == "__main__":
32
+ main()
@@ -0,0 +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()
@@ -0,0 +1,50 @@
1
+ Metadata-Version: 2.4
2
+ Name: joplin-mcp-server
3
+ Version: 0.1.0
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.10
12
+ Classifier: Programming Language :: Python :: 3.11
13
+ Classifier: Programming Language :: Python :: 3.12
14
+ Classifier: Programming Language :: Python :: 3.13
15
+ Classifier: Operating System :: POSIX :: Linux
16
+ Classifier: Operating System :: MacOS
17
+ Classifier: Operating System :: Microsoft :: Windows
18
+ Classifier: Intended Audience :: Developers
19
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
20
+ Classifier: Development Status :: 3 - Alpha
21
+ Requires-Python: >=3.10
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE.md
24
+ Requires-Dist: fastmcp==2.8.1
25
+ Requires-Dist: httpx==0.28.1
26
+ Dynamic: license-file
27
+
28
+ # joplin-mcp-server
29
+
30
+ A Model Context Protocol (MCP) stdio server for Joplin, exposing Joplin's local REST API as MCP tools.
31
+
32
+ - **Tech stack:** Python, uv, httpx, FastMCP
33
+ - **License:** MIT
34
+
35
+ ## Features
36
+ - Bridges Joplin's REST API to MCP tools
37
+ - Designed for extensibility and integration
38
+
39
+ ## Quick Start
40
+ 1. Clone this repository
41
+ 2. Set up a Python 3.10+ environment (recommended: `uv`)
42
+ 3. Install dependencies: `uv pip install -r pyproject.toml`
43
+ 4. Run the server: `uvx joplin-mcp-server`
44
+
45
+ ## Project Structure
46
+ - `src/joplin_mcp_server/` — Main package code
47
+ - `specs/` — API documentation and references
48
+
49
+ ## License
50
+ MIT
@@ -0,0 +1,10 @@
1
+ __init__.py,sha256=DjKJSPFBjFMWIB1WSdQIB3K3TI7d9Bk0H0xOJpuDrUI,21
2
+ joplin_mcp_server/__init__.py,sha256=e2iGMbIaofQC9CGoV8F1RrkdtnDK8Us_pj6ff0C08aA,35
3
+ joplin_mcp_server/entry.py,sha256=m9h4bkJTxkJQU_EUh6ebq1GyOFtC-lpDJ4GBa2wXl4s,612
4
+ joplin_mcp_server/joplin_client.py,sha256=mCqHbFSzcWm_Fq1iuRTlgYLq53ZLWLK_7wzspl_hAps,996
5
+ joplin_mcp_server-0.1.0.dist-info/licenses/LICENSE.md,sha256=H2a-nobfdapdoFZcyOw70l7d9E9NChOpE8dQ-qZM5hw,1067
6
+ joplin_mcp_server-0.1.0.dist-info/METADATA,sha256=Fw14cCvfspHVMBQHTeqAHGVs1p-SGvp_Q6ebAF9CyRU,1866
7
+ joplin_mcp_server-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
8
+ joplin_mcp_server-0.1.0.dist-info/entry_points.txt,sha256=VLkk0zkiRiHVJbVymY2z0APqib3Sk1C6Pq8ll9XyDcM,67
9
+ joplin_mcp_server-0.1.0.dist-info/top_level.txt,sha256=B6cW1I_mDJXOjgA8YyiBlzICbKnjriis2Qt1Gi1OSYY,27
10
+ joplin_mcp_server-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,5 @@
1
+ Wheel-Version: 1.0
2
+ Generator: setuptools (80.9.0)
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
5
+
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ joplin-mcp-server = joplin_mcp_server.entry:main
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 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.
@@ -0,0 +1,2 @@
1
+ __init__
2
+ joplin_mcp_server