Skip to content

Commit 0d4cfcf

Browse files
himaratsuhimaratsu
committed
README.mdを更新し、MCPクライアントの設定方法を3つの方法に分けて明確化。利用方法のセクションを追加し、具体的な質問例を示しました。
1 parent 18eaca8 commit 0d4cfcf

File tree

4 files changed

+177
-6
lines changed

4 files changed

+177
-6
lines changed

‎.github/workflows/build-dxt.yml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Build Desktop Extension (DXT)
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*'
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
12+
jobs:
13+
build:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@v4
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: '22'
24+
25+
- name: Install dependencies
26+
run: npm ci
27+
28+
- name: Build project
29+
run: npm run build
30+
31+
- name: Install DXT CLI globally
32+
run: npm install -g @anthropic-ai/dxt
33+
34+
- name: Create DXT package
35+
run: |
36+
# Get version from manifest.json
37+
VERSION=$(node -p "require('./manifest.json').version")
38+
echo "Building DXT for version: $VERSION"
39+
40+
# Create DXT directly in project root (dxt pack includes dependencies)
41+
npx @anthropic-ai/dxt pack
42+
43+
# Rename to include version
44+
mv microcms-document-mcp-server.dxt microcms-document-mcp-server-v${VERSION}.dxt
45+
46+
# Also create a copy without version for consistency
47+
cp microcms-document-mcp-server-v${VERSION}.dxt microcms-document-mcp-server.dxt
48+
49+
- name: Verify DXT creation
50+
run: |
51+
if [ ! -f microcms-document-mcp-server.dxt ]; then
52+
echo "Error: DXT file was failed to be created"
53+
exit 1
54+
fi
55+
ls -la *.dxt
56+
57+
- name: Upload DXT as artifact
58+
uses: actions/upload-artifact@v4
59+
with:
60+
name: microcms-document-mcp-server-dxt
61+
path: |
62+
microcms-document-mcp-server.dxt
63+
microcms-document-mcp-server-v*.dxt
64+
65+
release:
66+
needs: build
67+
runs-on: ubuntu-latest
68+
if: startsWith(github.ref, 'refs/tags/')
69+
70+
steps:
71+
- name: Download DXT artifact
72+
uses: actions/download-artifact@v4
73+
with:
74+
name: microcms-document-mcp-server-dxt
75+
76+
- name: List downloaded files
77+
run: ls -la
78+
79+
- name: Create Release
80+
uses: softprops/action-gh-release@v2
81+
with:
82+
files: |
83+
microcms-document-mcp-server.dxt
84+
microcms-document-mcp-server-v*.dxt
85+
generate_release_notes: true
86+
fail_on_unmatched_files: true

‎README.md‎

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,26 @@ microCMS ドキュメントにアクセスするための Model Context Protocol
77
この MCP サーバーは、microCMSの提供するドキュメントへのアクセスを提供します。
88
AI アシスタントが最新のドキュメント内容を検索・取得できるようにします。
99

10-
## 機能
1110

12-
- **fetch_general**: microCMSの一般的な内容を読み込みます
13-
- **list_documents**: `docs` ディレクトリ内の利用可能なドキュメントファイル一覧を返します
14-
- **search_document**: 指定されたドキュメントファイルの内容を取得します
11+
## MCP クライアントの設定
1512

13+
### 方法1. Cursorに設定する
1614

17-
## MCP クライアントの設定
15+
Cursorに導入する場合、以下のボタンをクリックするだけでインストールが完了します。
16+
17+
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=microcms-document&config=JTdCJTIyY29tbWFuZCUyMiUzQSUyMm5weCUyMC15JTIwbWljcm9jbXMtZG9jdW1lbnQtbWNwLXNlcnZlciUyMiU3RA%3D%3D)
18+
19+
### 方法2. Claude Desktopに設定する（DXT）
20+
21+
Claude Desktopに導入する場合、dxtファイルを使って簡単にインストールできます。
1822

19-
Claude Desktop や他の MCP クライアントでこのサーバーを使用するには、以下の設定を追加してください：
23+
1. リリースページ から最新の microcms-document-mcp-server.dxt をダウンロード
24+
2. Claude Desktopを起動し、設定 > エクステンション を開く
25+
3. ダウンロードしたdxtファイルをClaude Desktopにドラッグ＆ドロップ
26+
27+
### 方法3. その他のMCPクライアントに設定する
28+
29+
その他のMCPクライアントに導入する場合、設定ファイルに以下を追加してください。
2030

2131
```json
2232
{
@@ -29,6 +39,31 @@ Claude Desktop や他の MCP クライアントでこのサーバーを使用す
2939
}
3040
```
3141

42+
## 利用方法
43+
44+
セットアップ後、microCMSについての質問をするとAIが必要に応じてドキュメントを読み、回答します。
45+
チャットの文章に `use microcms-docs-mcp` と書くと明示的にMCPの利用を依頼することもできます。
46+
47+
microCMSの仕様について質問する
48+
```
49+
microCMSで、下書きで登録済みのコンテンツをAPI経由で公開したい。
50+
どのようなリクエストを送ればいい？
51+
```
52+
53+
microCMSのドキュメントを読みながら実装してもらう
54+
```
55+
microCMSで、特定の日付以降に更新されたコンテンツの一覧を取得するスクリプトを作ります。
56+
57+
- 環境変数でサービスIDとAPIキーを指定
58+
- コマンドライン引数でAPIエンドポイントと基準となる日付を指定
59+
- 結果は整形して表示
60+
61+
言語はJavaScriptでお願いします。
62+
63+
use microcms-docs-mcp
64+
```
65+
66+
3267
## 利用可能なツール
3368

3469
### fetch_general

‎assets/icon.png‎

2.66 KB
Loading

‎manifest.json‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
{
2+
"dxt_version": "0.1",
3+
"name": "microcms-document-mcp-server",
4+
"version": "0.1.2",
5+
"description": "microCMSドキュメントのMCP Serverです。LLMがmicroCMSの最新情報にアクセスして回答できるようになります。",
6+
"icon": "assets/icon.png",
7+
"author": {
8+
"name": "himaratsu",
9+
"url": "https://github.com/himaratsu"
10+
},
11+
"server": {
12+
"type": "node",
13+
"entry_point": "dist/index.js",
14+
"mcp_config": {
15+
"command": "node",
16+
"args": [
17+
"${__dirname}/dist/index.js"
18+
]
19+
}
20+
},
21+
"tools": [
22+
{
23+
"name": "fetch_general",
24+
"description": "microCMSの一般的な情報を返します。",
25+
"parameters": {}
26+
},
27+
{
28+
"name": "list_documents",
29+
"description": "docsディレクトリ内の利用可能なドキュメントファイル名の配列を返します。",
30+
"parameters": {}
31+
},
32+
{
33+
"name": "search_document",
34+
"description": "指定されたドキュメントファイルの内容を取得します。",
35+
"parameters": {
36+
"filename": "取得したいドキュメントファイル名（拡張子を含む）"
37+
}
38+
}
39+
],
40+
"keywords": [
41+
"microcms",
42+
"headlesscms",
43+
"document"
44+
],
45+
"license": "MIT",
46+
"repository": {
47+
"type": "git",
48+
"url": "git+https://github.com/himaratsu/microcms-document-mcp-server.git"
49+
}
50+
}

0 commit comments

Comments
 (0)