Skip to content

Commit 55f2362

Browse files
committed
package.jsonのバージョンを1.0.0から0.1.0に変更し、ライセンスをISCからMITに更新。README.mdを修正し、機能の説明を追加、セットアップ手順を整理。MCPクライアントの設定を明確化。
1 parent 94f0d80 commit 55f2362

File tree

2 files changed

+46
-35
lines changed

2 files changed

+46
-35
lines changed

README.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,53 @@
1-
# MicroCMS Document MCP Server
1+
# microCMS Document MCP Server
22

3-
MicroCMS ドキュメントを参照するための MCP (Model Context Protocol) サーバーです。
3+
microCMS ドキュメントにアクセスするための Model Context Protocol (MCP) サーバーです。
44

5-
## 機能
6-
7-
1. **list_documents**: docs/manual ディレクトリのファイル名一覧を返します
8-
2. **search_document**: 指定されたファイル名のドキュメント内容を返します
9-
10-
## セットアップ
11-
12-
```bash
13-
npm install
14-
npm run build
15-
```
16-
17-
## 使用方法
5+
## 概要
186

19-
### 開発環境での実行
7+
この MCP サーバーは、microCMSの提供するドキュメントへのアクセスを提供します。
8+
AI アシスタントが最新のドキュメント内容を検索・取得できるようにします。
209

21-
```bash
22-
npm run dev
23-
```
10+
## 機能
2411

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

27-
```bash
28-
npm run build
29-
npm start
30-
```
3116

32-
## MCP クライアントでの設定
17+
## MCP クライアントの設定
3318

34-
Claude Desktop や他の MCP クライアントで使用する場合は、以下のような設定を追加してください
19+
Claude Desktop や他の MCP クライアントでこのサーバーを使用するには、以下の設定を追加してください
3520

3621
```json
3722
{
3823
"mcpServers": {
3924
"microcms-document": {
40-
"command": "node",
41-
"args": ["/path/to/microcms-document-mcp-server/dist/index.js"]
25+
"command": "npx",
26+
"args": ["-y", "microcms-document-mcp-server"]
4227
}
4328
}
4429
}
45-
```# microcms-docs-mcp-server
30+
```
31+
32+
## 利用可能なツール
33+
34+
### fetch_general
35+
36+
microCMSの一般的な情報を返します。
37+
38+
### list_documents
39+
40+
`docs` ディレクトリ内の利用可能なドキュメントファイル名の配列を返します。
41+
42+
**戻り値**: ドキュメントファイル名の配列
43+
44+
### search_document
45+
46+
指定されたドキュメントファイルの内容を取得します。
47+
48+
**戻り値**: ドキュメントの内容(マークダウン形式のテキスト)
49+
50+
51+
## ライセンス
52+
53+
このプロジェクトは MIT ライセンスの下で公開されています。

package.json

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
{
22
"name": "microcms-document-mcp-server",
3-
"version": "1.0.0",
3+
"version": "0.1.0",
44
"description": "",
5-
"license": "ISC",
5+
"license": "MIT",
66
"author": "",
77
"type": "module",
88
"main": "dist/index.js",
99
"bin": {
10-
"microcms-document-mcp": "dist/index.js"
10+
"microcms-document-mcp-server": "dist/index.js"
1111
},
12+
"files": [
13+
"dist",
14+
"docs"
15+
],
1216
"scripts": {
1317
"build": "tsc",
1418
"start": "tsx src/index.ts",
15-
"dev": "tsx watch src/index.ts",
16-
"test": "echo \"Error: no test specified\" && exit 1"
19+
"dev": "tsx watch src/index.ts"
1720
},
1821
"dependencies": {
1922
"dotenv": "^17.1.0",
@@ -26,4 +29,4 @@
2629
"tsx": "^4.20.3",
2730
"typescript": "^5.8.3"
2831
}
29-
}
32+
}

0 commit comments

Comments
 (0)