MCP Pandoc

🚀 MCP-Pandoc 使用説明

このドキュメントでは、MCP-Pandoc のインストール方法、開発方法、および貢献方法について説明します。

📦 インストール

方法1：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"
    ]
  }
}

方法2：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. リポジトリをフォークします。
2. 新しい機能または修正のための独立したブランチを作成します。意味のあるブランチ名（例：feature/new-feature または bugfix/issue-123）を使用することをおすすめします。
3. コードをコミットする前に、コードフォーマットがプロジェクトの規則に従っていることを確認し、詳細なコミットメッセージを追加してください。
4. フォークしたリポジトリにブランチをプッシュした後、元のプロジェクトのメインブランチにプルリクエストを作成します。

貢献に関するガイドライン

• 問題報告：再現手順と関連するログをできるだけ明確に提供し、開発者が問題を迅速に特定できるようにしてください。
• コード貢献：プロジェクトのコーディング規約に従い、コードスタイルを統一し、適切なドキュメントコメントを追加してください。
• ドキュメント更新：ドキュメントの改善提案がある場合は、直接プルリクエストを作成して関連するドキュメントを更新してください。

ご関心とご支援いただき、ありがとうございます！mcp-pandoc があなたのニーズを満たすことができることを願っています。ご意見や協力を歓迎します。