tiddly-mcp

🚀 Tiddly MCP

Tiddly MCP是一个适用于 TiddlyWiki 的 模型上下文协议（Model Context Protocol） 插件，它能让你将AI代理连接到你的TiddlyWiki。

警告： 此插件仍在开发中。

该插件已通过以下工具的测试并能正常工作：

• Gemini CLI
• Claude Code
• Claude
• Simtheory

该插件仅支持服务器（由Node.js托管）版本的TiddlyWiki。

此插件通过MCP为AI代理提供以下工具：

| 名称 | 描述 | 参数 | | ---- | ----------- | --------- | | list_tiddlers | 列出所有条目，或使用 过滤表达式 对其进行过滤。 | filter、limit、includeSystem、includeDetails | | read_tiddler | 按标题读取一个条目。 | title | | search_tiddlers | 搜索包含特定文本的条目。 | query、field、caseSensitive | | write_tiddler | 按标题创建或更新一个条目。 | title、text、tags、type、username | | delete_tiddler | 按标题删除一个条目。 | title |

该插件默认处于 只读 模式。更新和删除条目的工具默认是关闭的。

🚀 快速开始

Tiddly MCP插件能助力你把AI代理与TiddlyWiki相连接，以下为你介绍其使用方式。

✨ 主要特性

• 支持多种AI工具，如Gemini CLI、Claude Code、Claude和Simtheory。
• 为AI代理提供了一系列操作TiddlyWiki条目的工具，包括列出、读取、搜索、写入和删除条目。
• 默认处于只读模式，保障数据安全性。

📦 安装指南

此插件仅适用于服务器（由Node.js托管）版本的TiddlyWiki。

1. 将 $__plugins_rryan_tiddly-mcp.json 拖放到你的 由Node.js托管的 TiddlyWiki中并导入该条目，或者将 tiddly-mcp 文件夹复制到你的TiddlyWiki插件路径中。
2. 打开插件配置，自定义端口和其他设置。
3. 重启服务器，并确认在日志中看到 [MCP] TiddlyWiki MCP Server started on port XXXX。

⚠️ 重要提示

⚠️ 重要提示

目前，我们建议不要将此MCP服务器暴露在互联网上。你可以在本地将该插件与Gemini CLI、Claude Code或Claude Desktop配合使用，这样不会有任何安全风险。

如果你确实要将该插件暴露在互联网上，我们建议：

• 像搭建Node.js托管的TiddlyWiki一样，将其设置在反向代理之后。
• 使用HTTP基本身份验证来保护访问。大多数客户端支持自定义标头，你可以通过它提供 Authentication: Basic asdf1234 身份验证标头。
• 将CORS允许的主机设置为你托管它的域名。
• 使用 https://example.com/mcp 以外的路径，以避免攻击者扫描MCP服务器。

💻 使用示例

开发构建

若要构建插件的JSON文件和文件夹，请执行以下命令：

pnpm install
pnpm build:folder

单元测试

若要运行单元测试，请执行以下命令：

pnpm test

集成测试

若要使用MCP客户端针对开发服务器运行集成测试，请执行以下命令：

pnpm test:live

📚 详细文档

致谢

• 此插件最初由Claude Code和Gemini CLI开发。
• 感谢 https://github.com/tiddly-gittly/Modern.TiddlyDev 提供的优秀TypeScript入门套件，用于TiddlyWiki插件开发。