Skip to content

Model Context Protocol (MCP) server for TiddlyWiki - enables AI agents to interact with your wiki.

License

Notifications You must be signed in to change notification settings

rryan/tiddly-mcp

Repository files navigation

Tiddly MCP

Tiddly MCP is a Model Context Protocol plugin for TiddlyWiki that lets you connect AI agents to your TiddlyWiki.

WARNING: This plugin is a work in progress.

This plugin is tested and works with:

The plugin only supports server (Node.JS-hosted) versions of TiddlyWiki.

This plugin provides the following tools to AI agents via MCP:

Name Description Arguments
list_tiddlers List all tiddlers or filter them using a filter expression. filter, limit, includeSystem, includeDetails
read_tiddler Read a tiddler by title. title
search_tiddlers Search for tiddlers containing specific text. query, field, caseSensitive
write_tiddler Create or update a tiddler by title. title, text, tags, type, username
delete_tiddler Deletes a tiddler by title. title

The plugin defaults to read only mode. The update and delete tiddler tools are off by default.

Installation

This plugin only works with server (hosted on Node.JS) TiddlyWikis.

  1. Drag and drop $__plugins_rryan_tiddly-mcp.json into your Node.JS-hosted TiddlyWiki and import the tiddler, or copy the tiddly-mcp folder into your TiddlyWiki plugin path.
  2. Open the plugin configuration and customize the port and other settings.
  3. Restart your server and confirm you see [MCP] TiddlyWiki MCP Server started on port XXXX in your logs.

Authentication

For now, we recommend not exposing this MCP server to the Internet. You can use the plugin locally with Gemini CLI, Claude Code, or Claude Desktop without any security risks.

If you do expose the plugin to the Internet, we recommend:

  • Set it up behind a reverse proxy, just like your Node.JS-hosted TiddlyWik is.
  • Use HTTP Basic Authentication to protect access. Most clients support custom headers that allow you to provide a Authentication: Basic asdf1234 authentication header.
  • Set the CORS allowed hosts to the domain name you are hosting it on.
  • Use a path other than https://example.com/mcp to avoid attackers scanning for MCP servers.

Developing

To build the plugin JSON and folder:

pnpm install
pnpm build:folder

To run the unit tests:

pnpm test

To run integration tests with an MCP client against a development server:

pnpm test:live

Acknowledgements

About

Model Context Protocol (MCP) server for TiddlyWiki - enables AI agents to interact with your wiki.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published