mcpField
S
scribe

scribe

ローカル
scribe.writulos.com開発ツール02 週間前に更新
リポジトリ公式サイト

scribe について

scribeは、Writulos Scribeの利用者やMCP対応クライアント向けに、ソースコードからMarkdown文書を生成するMCPサーバーです。単一ファイルまたは最大20ファイルを処理し、生成結果をクライアントのチャットに返します。

主な機能

  1. 01単一コードファイルのMarkdown生成
  2. 02最大20ファイルの一括処理
  3. 03ファイル名と追加コンテキストの指定
  4. 04クライアントのチャットへの文書返却
  5. 05実行ログの記録

活用シーン

  1. 01コーディング中のソースファイル文書化
  2. 02複数ファイルの文書を一括生成
  3. 03ファイル文書に必要な背景情報の追加

MCP 対応

MCPクライアントに `generate_docs` と `generate_docs_batch` を提供します。生成にはWritulos ScribeのAPIキーが必要です。

設定

ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。

mcp.json · 共通設定
{
  "mcpServers": {
    "com-writulos-scribe": {
      "command": "npx",
      "args": [
        "-y",
        "writulos-mcp"
      ],
      "env": {
        "WRITULOS_API_KEY": "<WRITULOS_API_KEY>",
        "WRITULOS_OUTPUT_DIR": "<WRITULOS_OUTPUT_DIR>",
        "WRITULOS_PROJECT_ROOT": "<WRITULOS_PROJECT_ROOT>",
        "WRITULOS_API_URL": "<WRITULOS_API_URL>"
      }
    }
  }
}
起動コマンドnpx -y writulos-mcp
設定が必要な環境変数
WRITULOS_API_KEYシークレットYour Writulos Scribe API key, from https://scribe.writulos.com/dashboard/api-keys
WRITULOS_OUTPUT_DIRDirectory for the run log (writulos.log). Defaults to "docs", relative to the project root.
WRITULOS_PROJECT_ROOTProject root the run log is written under. Defaults to the working directory.
WRITULOS_API_URLOverride the API base URL, for testing against another deployment. Defaults to https://scribe.writulos.com/api

ローカルサーバーにはマシン上の実行環境（Node.js 18 以上など）が必要です。設定ファイルの場所はクライアントごとに異なります。

パッケージ
npmwritulos-mcp1.0.3

ツール

2

掲載時のツール一覧 · 1 週間前に更新

パラメーター型必須説明
codestringはいドキュメント化するソースコード。
contextstringいいえファイルまたはプロジェクトに関する任意の追加コンテキスト。
filenamestringいいえファイル名（例：auth.js）

詳細

writulos-mcp

Writulos Scribe の公式 MCP サーバーです。Cursor、Claude Desktop、および MCP 互換のあらゆる AI エージェント内で、コードの Markdown ドキュメントを生成します。

インストール

インストールは不要です。npx で直接実行できます。

npx writulos-mcp

または、グローバルにインストールします。

npm install -g writulos-mcp

Cursor でのセットアップ

プロジェクトのルートにある .cursor/mcp.json に、以下を追加します。

{
  "mcpServers": {
    "writulos": {
      "command": "npx",
      "args": ["-y", "writulos-mcp"],
      "env": {
        "WRITULOS_API_KEY": "writ_YOUR_API_KEY"
      }
    }
  }
}

Cursor を再起動します。次に、AI チャットで以下のように依頼します。

Document all the files in this project using writulos

生成されたドキュメントはチャットに表示されます。Cursor に、ドキュメントを保存している場所へ保存するよう依頼してください。サーバーが書き込むのは docs/writulos.log への実行ログだけです（保存先を変更するには WRITULOS_OUTPUT_DIR を設定します）。このログには、各実行と今月の残りの生成回数が記録されます。

Claude Code、Claude Desktop、その他のクライアントでのセットアップ

上記の Cursor 設定と同じ command、args、env を使用します。クライアントにサーバーを追加する方法にかかわらず、WRITULOS_API_KEY を指定してください。キーがなくてもサーバーは起動しますが、すべてのツール呼び出しに、キーの取得先が表示されます。

使用方法と制限

ドキュメントを生成するファイルごとに、Writulos のプランで毎月利用できる生成回数を 1 回消費します。この回数は、ダッシュボードや GitHub Action が使用するものと共通です。上限に達すると、ツールがその旨とリセット時期を通知します。

ツール

generate_docs

1 つのコードファイルの Markdown ドキュメントを生成します。

入力：

  • code（必須）— ソースコード
  • filename（任意）— 例：auth.js
  • context（任意）— ファイルに関する追加情報
generate_docs_batch

1 回のリクエストで最大 20 個のファイルの Markdown ドキュメントを生成します。

入力：

  • files（必須）— { code, filename?, context? } オブジェクトの配列

要件

ソースと問題の報告

このリポジトリはサーバーのコピーで、リリースごとに更新されます。バグの報告や質問は、issues でお知らせください。

ライセンス

MIT

コメント

Markdown 対応

MCP は初めてですか？

プロトコルの概要から最初のサーバーの導入まで、よくある疑問にまとめて答えます。

AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。