@timakin/basemachina-mcp-docs-server
v0.1.1
Published
MCP server for BaseMachina documentation and showcase
Maintainers
Readme
BaseMachina MCP Docs Server
BaseMachina MCP Docs Serverは、BaseMachinaのドキュメント、ショーケース、コンポーネント情報にアクセスするためのModel Context Protocol (MCP) サーバーです。AIアシスタントが簡単にBaseMachinaの情報にアクセスできるようになります。
機能
- ドキュメント: BaseMachinaのドキュメントにアクセスし、特定のページや章を参照できます
- ショーケース: ビュー実装の例を参照し、実際のコード例を確認できます
- コンポーネント: 組み込み関数やコンポーネントの使用方法の詳細情報を取得できます
- 検索: ドキュメントとショーケース全体を検索し、関連情報を素早く見つけられます
インストール
Cursor
Cursorでこのサーバーを使用するには、プロジェクトのルートに .cursor/mcp.json ファイルを作成または更新します:
{
"mcpServers": {
"basemachina": {
"command": "npx",
"args": ["-y", "basemachina-mcp-docs-server@latest"]
}
}
}Claude デスクトップ
Claude デスクトップで使用するには、次の設定ファイルを編集します:
macOS/Linux:
// ~/Library/Application Support/Claude/claude_desktop_config.json
{
"mcpServers": {
"basemachina": {
"command": "npx",
"args": ["-y", "basemachina-mcp-docs-server@latest"]
}
}
}Windows:
// %APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"basemachina": {
"command": "cmd",
"args": ["/c", "npx", "-y", "basemachina-mcp-docs-server@latest"]
}
}
}使用方法
サーバーが接続されると、次のツールを使用できるようになります:
ドキュメントツール (basemachinaDocs)
特定のドキュメントパスのコンテンツを取得します:
パラメータ:
- path: 取得するドキュメントパス(例:"view/basic", "action/data")例:
basemachinaDocs()- ナビゲーション構造を返しますbasemachinaDocs({ path: "view/basic" })- Basic Viewのドキュメントを返します
ショーケースツール (basemachinaShowcase)
ビュー実装の例を表示します:
パラメータ:
- category: 例のカテゴリ(例:"form", "table", "chart")
- example: 特定の例の名前例:
basemachinaShowcase()- 利用可能なカテゴリ一覧を返しますbasemachinaShowcase({ category: "form" })- フォームの例一覧を返しますbasemachinaShowcase({ category: "form", example: "basic-form" })- 基本的なフォームの例を返します
コンポーネントツール (basemachinaComponent)
組み込み関数やコンポーネントに関する情報を提供します:
パラメータ:
- name: コンポーネントまたは関数の名前例:
basemachinaComponent()- 利用可能なコンポーネント一覧を返しますbasemachinaComponent({ name: "TextInput" })- TextInputコンポーネントの情報を返します
検索ツール (basemachinaSearch)
ドキュメンテーションとショーケース全体を検索します:
パラメータ:
- query: 検索クエリ
- limit: 返す結果の最大数(デフォルト: 5)例:
basemachinaSearch({ query: "フォーム検証" })- フォーム検証に関する情報を検索しますbasemachinaSearch({ query: "テーブル", limit: 10 })- テーブルに関する情報を10件まで検索します
開発
このリポジトリをクローンした後:
# 依存関係をインストール
npm install
# 開発モードで実行
npm run dev
# ビルド
npm run build
# 実行
npm startライセンス
ISC
