Documize MCP Server

文档化MCP服务器

模型上下文协议（MCP）服务器，提供与Documize API的无缝集成。该服务器使像Claude这样的人工智能助手能够与您的Documize知识库进行交互，包括搜索文档、管理空间、处理附件等。

特性

• 🔍 搜索：跨文档和内容的全文搜索
• 📄 文件：完成文档的CRUD操作
• 📝 页面：精细的页面级内容管理
• 📁 空间：管理空间和权限
• 📎 导入/导出：导入文档（HTML/Markdown/Word）和导出（PDF/HTML/DOCX）
• 👥 用户和组：用户和组管理
• 🧪 测试良好：92.68%的代码覆盖率，具有全面的单元测试
• � 可靠的：瞬态错误的自动重试逻辑

完整工具清单（24个工具）

文档（4个工具）

• get_document -按ID获取包含内容和元数据的文档
• list_documents -列出空间中的所有文档
• update_document -更新现有文档
• delete_document -删除文档

注： 文档只能通过以下方式创建 import_document （请参见导入/导出工具）

页面（5个工具）

• get_pages -获取文档中的所有页面
• get_page -获取特定页面
• create_page -使用HTML内容创建新页面
• update_page -更新现有页面
• delete_page -删除页面

空格（4个工具）

• list_spaces -列出所有可用空间
• get_space -获取空间详细信息
• create_space -创建新空间
• delete_space -删除空格

用户（3个工具）

• list_users -列出所有用户
• create_user -创建新用户
• delete_user -删除用户

组（2个工具）

• list_groups -列出所有组
• join_group -将用户添加到组
• leave_group -从组中删除用户

导入/导出（4个工具）

• import_document -导入HTML、Markdown或Word文件（创建新文档）
• export_pdf -将文档导出为PDF
• export_html -将文档导出为HTML
• export_docx -将文档导出为DOCX

注： 只能通过以下方式创建文档 import_document

搜索（1个工具）

• search -跨文档、空间和附件的全文搜索

快速开始

安装

npm install -g documize-mcp-server

配置

1. 获取您的Documize证书:

- 域（对于自托管实例通常为空） - 电子邮件 - 密码

1. 对凭据进行编码:

   # For self-hosted (domain is empty)
   echo -n ":email:password" | base64

   # For multi-tenant (with domain)
   echo -n "domain:email:password" | base64

1. 为Claude桌面配置:

编辑 ~/Library/Application Support/Claude/claude_desktop_config.json:

   {
     "mcpServers": {
       "documize": {
         "command": "documize-mcp-server",
         "env": {
           "DOCUMIZE_API_URL": "https://your-instance.com",
           "DOCUMIZE_API_CREDENTIALS": "your-base64-credentials"
         }
       }
     }
   }

1. 重新启动克劳德桌面

VS代码GitHub副本

1. 安装服务器:

   npm install -g documize-mcp-server

1. 配置 .vscode/mcp.json 在您的工作空间中：

   {
     "mcpServers": {
       "documize": {
         "command": "documize-mcp-server",
         "env": {
           "DOCUMIZE_API_URL": "https://your-instance.com",
           "DOCUMIZE_API_CREDENTIALS": "your-base64-credentials"
         }
       }
     }
   }

1. 重新加载VS代码

使用示例

看 QUICKSTART.md 详细示例和 docs/API-REFERENCE.md文件 获取完整的API文档。

搜索文档

Search for documents about "project requirements"

导入文档（创建）

Import this HTML file into the Engineering space to create a new document:

Meeting Notes

Discussion about project requirements...

管理页面

Add a new section to document abc123 with title "Introduction"

导入文档

Import the markdown file README.md into the Documentation space

导出文档

Export document abc123 as PDF

发展

先决条件

• Node.js 18+
• npm或纱线
• 具有API访问权限的Documize实例

设置

git clone https://github.com/artfulhacker/documize-mcp-server.git
cd documize-mcp-server
npm install

构建

npm run build

测试

运行覆盖范围完整的测试套件：

npm test              # Run all tests once
npm run test:watch    # Run tests in watch mode
npm run test:ui       # Run tests with interactive UI
npm run test:coverage # Run with coverage report

测试覆盖率：92.68%（7个测试套件中的68个测试）

集成测试

对实时Documize实例运行集成测试：

npm run integration-test

备注：集成测试需要中的有效凭据 .env 文件。

使用MCP检查员进行测试

npm run inspector

API文档

• 完整的API参考资料 -记录所有24个工具
• 将API文档文档化
• MCP规范
• TypeScript SDK

项目状态

版本: 1.1.0\ 状态：生产就绪\ 测试覆盖率92.68%（68个单元测试+集成测试）\ 工具：24个MCP工具，涵盖完整的Documize API\ 特性：自动重试逻辑，全面的错误处理，完全支持TypeScript

贡献

欢迎投稿！看 贡献.md 作为指导方针。

安全

看 安全.md 出于安全考虑和最佳实践。

许可证

MIT许可证-请参阅 许可证 了解详情。

链接

• 仓库: https://github.com/artfulhacker/documize-mcp-server
• 问题: https://github.com/artfulhacker/documize-mcp-server/issues
• NPM: https://www.npmjs.com/package/documize-mcp-server
• 更新日志: 更改日志.md

致谢

与 模型上下文协议 通过Anthropic。

______________________________________________________________________

由……制造 @狡猾的黑客