DeepWriter MCP サーバー

DeepWriter APIと連携するためのモデルコンテキストプロトコル（MCP）サーバー。このサーバーは、標準化されたMCPインターフェースを通じて、DeepWriterプロジェクトのコンテンツを作成、管理、生成するためのツールを提供します。

特徴

プロジェクト管理: プロジェクトの作成、一覧表示、更新、削除
コンテンツ生成: DeepWriterのAIを使用してプロジェクトのコンテンツを生成します
プロジェクトの詳細: プロジェクトの詳細情報を取得します
MCP 統合: Claude やその他の MCP 対応 AI アシスタントとシームレスに統合
標準 MCP 機能: MCP プロトコルバージョン 2025-03-26 を実装
トランスポートサポート: ローカルプロセス通信用のstdioトランスポート

前提条件

Node.js (v17以上)
npm (v6以上)
DeepWriter APIキー
MCP 互換クライアント (例: Claude for Desktop)

インストール

リポジトリをクローンします。
git clone https://github.com/yourusername/deepwriter-mcp.git cd deepwriter-mcp
依存関係をインストールします:
npm install
DeepWriter API キーを使用して、ルートディレクトリに.envファイルを作成します。
DEEPWRITER_API_KEY=your_api_key_here
プロジェクトをビルドします。
npm run build

使用法

サーバーの起動

MCP サーバーを起動します。

node build/index.js

サーバーは、MCP stdio トランスポート仕様に従って、stdin で MCP 要求をリッスンし、stdout で応答します。

Claude for Desktop への接続

Claude for Desktop で DeepWriter MCP サーバーを使用するには:

Claude for Desktop の構成ファイルを開きます。
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%\Claude\claude_desktop_config.json
サーバー構成を追加します。
{ "mcpServers": { "deepwriter": { "command": "node", "args": ["/ABSOLUTE/PATH/TO/deepwriter-mcp/build/index.js"], "env": { "DEEPWRITER_API_KEY": "your_api_key_here" } } } }
新しい構成を読み込むには、Claude for Desktop を再起動します。

MCPプロトコルサポート

このサーバーは、次の機能を備えた MCP プロトコルバージョン 2025-03-26 を実装しています。

トランスポート: ローカルプロセス通信用のstdioトランスポート
ツール: すべてのDeepWriter API操作を完全にサポート
ログ記録: 構成可能なレベルを持つ構造化されたログ記録

利用可能なツール

1. プロジェクトの一覧

DeepWriter アカウントに関連付けられているすべてのプロジェクトを一覧表示します。

{
  "api_key": "your_api_key_here"
}

2. プロジェクトの詳細を取得する

特定のプロジェクトに関する詳細情報を取得します。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

3. プロジェクトを作成する

指定されたタイトルとメールで新しいプロジェクトを作成します。

{
  "api_key": "your_api_key_here",
  "title": "Your Project Title",
  "email": "your_email@example.com"
}

4. プロジェクトの更新

指定された変更で既存のプロジェクトを更新します。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "updates": {
    "title": "Updated Project Title",
    "prompt": "Updated project prompt",
    "author": "Updated author name",
    "email": "updated@email.com",
    "model": "Updated model name",
    "outline_text": "Updated outline",
    "style_text": "Updated style guide",
    "supplemental_info": "Updated additional information",
    "work_description": "Updated work description",
    "work_details": "Updated work details",
    "work_vision": "Updated work vision"
  }
}

5. 作業を生成する

DeepWriter の AI を使用してプロジェクトのコンテンツを生成します。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here",
  "is_default": true // Optional, defaults to true
}

6.プロジェクトを削除する

プロジェクトを削除します。

{
  "api_key": "your_api_key_here",
  "project_id": "your_project_id_here"
}

発達

プロジェクト構造

deepwriter-mcp/
├── src/
│   ├── index.ts              # Main entry point and MCP server setup
│   ├── api/
│   │   └── deepwriterClient.ts  # DeepWriter API client
│   └── tools/                # MCP tool implementations
│       ├── createProject.ts
│       ├── deleteProject.ts
│       ├── generateWork.ts
│       ├── getProjectDetails.ts
│       ├── listProjects.ts
│       └── updateProject.ts
├── build/                    # Compiled JavaScript output
├── test-deepwriter-tools.js  # Tool testing script
├── test-mcp-client.js       # MCP client testing script
└── tsconfig.json            # TypeScript configuration

建物

npm run build

これにより、TypeScript コードがbuildディレクトリ内の JavaScript にコンパイルされます。

テスト

提供されているテストスクリプトを使用して、MCP サーバーをローカルでテストできます。

node test-mcp-client.js

または

node test-deepwriter-tools.js

TypeScriptの設定

このプロジェクトでは、ESモジュールとNode.jsモジュール解決を備えたTypeScriptを使用しています。主なTypeScript設定：

{
  "compilerOptions": {
    "target": "ES2022",
    "module": "Node16",
    "moduleResolution": "Node16",
    "outDir": "./build",
    "strict": true
  }
}

トラブルシューティング

よくある問題

APIキーの問題:
- DeepWriter APIキーが.envファイルに正しく設定されていることを確認してください
- ツールの引数にAPIキーが正しく渡されているか確認する
- APIキーに必要な権限があることを確認する
接続の問題:
- DeepWriter APIがネットワークからアクセスできることを確認してください
- 接続をブロックする可能性のあるファイアウォールやプロキシ設定を確認してください
- ネットワーク接続が安定していることを確認してください
MCP プロトコルの問題:
- 互換性のあるMCPクライアントを使用していることを確認してください
- stdioトランスポートが正しく設定されているか確認する
- クライアントがプロトコルバージョン 2025-03-26 をサポートしていることを確認します
パラメータの命名:
- サーバーは、スネークケース（ project_id ）とキャメルケース（ projectId ）の両方のパラメータ名をサポートしています。
- すべてのパラメータは大文字と小文字が区別されます
- 必須パラメータは null または未定義であってはなりません

デバッグ

詳細なログを取得するには、DEBUG 環境変数を使用してサーバーを実行します。

DEBUG=deepwriter-mcp:* node build/index.js

Claude for Desktop のログは次の場所でも確認できます。

macOS: ~/Library/Logs/Claude/mcp*.log
Windows: %APPDATA%\Claude\logs\mcp*.log

貢献

コミュニティからの貢献を歓迎します！ご協力いただける方法は以下の通りです。

問題の提出

バグレポート
- GitHubの問題追跡ツールを使用する
- バグを再現するための詳細な手順を含める
- 環境の詳細（Node.js のバージョン、OS など）を入力してください。
- 関連するログとエラーメッセージを含める
- 提供されているバグレポートテンプレートを使用する
機能リクエスト
- GitHubの問題追跡ツールで「機能強化」ラベルを使用する
- 機能とその使用例を明確に説明する
- プロジェクトにどのようなメリットがあるのかを説明する
- 提供されている機能リクエストテンプレートを使用する
セキュリティ問題
- セキュリティ上の脆弱性については、公開問題を作成しないでください。
- 代わりにsecurity@deepwriter.comにメールしてください
- 脆弱性に対処するために協力します
- 当社は責任ある情報開示慣行に従います

プルリクエスト

始める前に
- 重複作業を避けるために既存の問題とPRをチェックする
- 大きな変更については、まず問題を開いて議論してください
- コーディング標準とMCP実装ガイドラインを読む
開発プロセス
- リポジトリをフォークする
- mainから新しいブランチを作成する
- コーディングスタイルと規約に従ってください
- 新機能のテストを追加する
- 必要に応じてドキュメントを更新する
PR要件
- 変更点を明確に説明する
- リンク関連の問題
- テストを追加または更新する
- ドキュメントの更新
- コミットメッセージの慣例に従う
- 貢献者ライセンス契約（CLA）に署名する
コードレビュー
- すべてのPRには少なくとも1回のレビューが必要です
- レビューのフィードバックに対応する
- PRを焦点を絞って適切なサイズに保つ
- 質問やコメントに応答する

開発ガイドライン

コードスタイル
- TypeScriptのベストプラクティスに従う
- ESLintの設定を使用する
- Prettierでコードをフォーマットする
- MCPプロトコル仕様に従う
テスト
- 新しい機能のユニットテストを書く
- テスト範囲を維持または改善する
- MCPプロトコルコンプライアンスのテスト
- 複数のNode.jsバージョンでテストする
ドキュメント
- ユーザー向けの変更については README.md を更新してください
- 新しいコードに JSDoc コメントを追加する
- APIドキュメントを更新する
- 新機能の例を含める
コミットメッセージ
- 従来のコミット形式に従う
- 適切な場合の参照問題
- コミットを集中的かつアトミックに保つ
- 明確で説明的なメッセージを使用する

ヘルプの取得

Discordコミュニティに参加する
ドキュメントを確認する
GitHubのディスカッションで質問する
毎月の寄稿者向け電話会議にご参加ください

安全

サーバーは処理前にすべての入力を検証します
APIキーは記録されず、エラーメッセージにも表示されません。
stdioトランスポートはプロセス分離を提供する
すべての外部API呼び出しはHTTPSを使用します
入力検証によりインジェクション攻撃を防止

ライセンス

マサチューセッツ工科大学

DeepWriter MCP Server

Integrations