🚀 MCP - Pandoc 使用说明

MCP - Pandoc 是一款为 Claude Desktop 提供支持的工具，可通过多种方式进行安装和开发，本说明将详细介绍其安装、开发及贡献的相关步骤。

📦 安装指南

方式一：通过 claude_desktop_config.json 配置文件手动安装

• MacOS 系统：打开路径 ~/Library/Application\ Support/Claude/claude_desktop_config.json。
• Windows 系统：打开路径 %APPDATA%/Claude/claude_desktop_config.json。

"mcpServers": {
  "mcp-pandoc": {
    "command": "uv",
    "args": [
      "--directory",
      "<DIRECTORY>/mcp-pandoc",
      "run",
      "mcp-pandoc"
    ]
  }
}

"mcpServers": {
  "mcp-pandoc": {
    "command": "uvx",
    "args": [
      "mcp-pandoc"
    ]
  }
}

方式二：通过 Smithery 自动安装已发布的服务器配置

运行以下 bash 命令，自动通过 Smithery 安装 已发布 的 mcp - pandoc pypi 用于 Claude Desktop：

npx -y @smithery/cli install mcp-pandoc --client claude

⚠️ 重要提示

如需使用本地配置的 mcp - pandoc，请按照上方“开发/未发布服务器配置”步骤操作。

🔧 开发指南

构建与发布

为了将包准备为发行版本，可按以下步骤操作：

1. 同步依赖项并更新锁定文件

uv sync

2. 构建发行版分发

uv build

此命令将在 dist/ 目录下创建源代码和轮文件（wheel）。

3. 发布到 PyPI

uv publish

⚠️ 重要提示

您需要通过环境变量或命令行参数设置 PyPI 凭证：

• 令牌：--token 或 UV_PUBLISH_TOKEN
• 或者用户名/密码：--username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

调试

由于 MCP 服务器通过标准输入输出运行，调试较为困难。为了获得最佳的调试体验，我们强烈推荐使用 MCP Inspector。

您可以使用以下命令启动 MCP Inspector：

npx @modelcontextprotocol/inspector uv --directory /Users/vivekvells/Desktop/code/ai/mcp-pandoc run mcp-pandoc

启动后，Inspector 会显示一个 URL，您可以在浏览器中访问该 URL 开始调试。

🤝 贡献指南

我们欢迎对 mcp - pandoc 提交贡献！以下是如何参与项目的一些指导：

提交问题

如遇到任何问题，请通过 GitHub Issues 提交问题。在提交前，请先搜索已有问题，确保您的问题尚未被提出。

提交功能或修复

1. 叉仓库（Fork repository）：首先 Fork 本项目到您自己的账户。
2. 创建分支（Create a branch）：为新功能或修复创建一个独立的分支，建议使用有意义的分支名称，如 feature/new-feature 或 bugfix/issue-123。
3. 提交代码（Commit code）：在提交代码前，请确保代码格式符合项目规范，并添加详细的提交信息。
4. 创建拉取请求（Create a Pull Request）：将您的分支推送到 Fork 仓库后，创建一个 Pull Request 到原项目的主分支。

贡献建议

💡 使用建议

• 问题报告：请尽量提供清晰的复现步骤和相关日志，方便开发人员快速定位问题。
• 代码贡献：请遵循项目编码规范，确保代码风格统一，并添加相应的文档注释。
• 文档更新：如对文档有改进意见，请直接提交 Pull Request 更新相关文档。

感谢您的关注与支持！希望 mcp - pandoc 能够满足您的需求，并欢迎任何反馈与合作。