MCP Pandoc

🚀 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 能夠滿足您的需求，並歡迎任何反饋與合作。