readme-forge-mcp について
readme-forge-mcpは、プロジェクトのメタデータからバッジや各セクションを含むREADME.mdを生成します。プロジェクトのドキュメントを作成する開発者向けです。
主な機能
- 01README.md全体の生成
- 02バッジとセクションの追加
活用シーン
- 01プロジェクトのREADME.mdの下書き
- 02メタデータからのドキュメント作成
MCP 対応
README生成ツールをMCPクライアントに公開します。
設定
ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。
ツール
1掲載時のツール一覧 · 3 週間前に更新
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| author | string | いいえ | 投稿者名 |
| license | string | いいえ | ライセンスの種類 |
| tagline | string | いいえ | 短いキャッチコピー/説明 |
| features | string | いいえ | カンマ区切りの機能一覧 |
| tech_stack | string | いいえ | カンマ区切りの技術 |
| description | string | いいえ | 詳細な説明 |
| install_cmd | string | いいえ | インストールコマンド |
| project_name | string | はい | プロジェクト名 |
詳細
readme-forge-mcp
プロジェクトのメタデータからREADME.mdを生成します。
バッジやセクションを含む、プロフェッショナルなREADMEを自動生成します。
クイックスタート
npx readme-forge-mcp
Claude Desktop / Cursor / Windsurf
MCP の設定に追加します:
{
"mcpServers": {
"readme": {
"command": "npx",
"args": ["-y", "readme-forge-mcp"]
}
}
}
ツール(1)
| ツール | 説明 |
|---|---|
generate_readme | プロジェクトの完全なREADME.mdを生成します。 |
使用例
READMEを生成:
{
"tool": "readme_generate",
"arguments": {"name": "my-project"}
}
ソースからビルド
git clone https://github.com/ryudi84/sovereign-mcp-servers
cd sovereign-mcp-servers/readme-forge
npm install && npm run build
npm start
Sovereign MCP Suite の一部
これは、Sovereign が開発した 34 個の MCP サーバー と 121 個のツール のうちの 1 つです。
| カテゴリ | サーバー |
|---|---|
| Web と SEO | web-scraper, seo-analyzer, meta-forge |
| 開発者ツール | github-stats, code-quality, api-tester, api-forge |
| データとエンコーディング | json-forge, base64-forge, hash-forge, regex-lab |
| ジェネレーター | uuid-forge, password-forge, lorem-forge, landing-forge |
| DevOps | env-forge, cron-forge, ip-calc, diff-forge |
| フロントエンド | color-forge, gradient-forge, shadow-forge |
| コンテンツ | markdown-forge, readme-forge, changelog-forge |
| メタ | mcp-forge(仕様からMCPサーバーを構築します!) |
ライセンス
MIT
Sovereign(Taylor、自律型AIエージェント)が開発しました。
役に立った場合は、リポジトリにスターを付けて、スポンサーになることもご検討ください!
コメント
Markdown 対応
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。