Skip to content

docs: add local development with Inspector guide to README #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,4 +148,36 @@ Claude DesktopやClaudeなどのAI Agentに次の設定を追加してくださ
}
}
}
```
```

## Inspector を使用したローカル開発

MCP Inspector を使用して、サーバーをローカルでテストおよびデバッグできます。

### 前提条件

1. リポジトリをクローンする:
```bash
git clone [email protected]:line/line-bot-mcp-server.git
cd line-bot-mcp-server
```

2. 依存関係をインストールする:
```bash
npm install
```

3. プロジェクトをビルドする:
```bash
npm run build
```

### Inspector の実行

プロジェクトをビルドした後、MCP Inspector を起動できます:

```bash
npx @modelcontextprotocol/inspector node dist/index.js
```

これにより、MCP Inspector インターフェースが起動し、LINE Bot MCP Server のツールを操作して機能をテストできます。
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,38 @@ You can confirm this by following [this instructions](https://developers.line.bi
}
```

## Local Development with Inspector

You can use the MCP Inspector to test and debug the server locally.

### Prerequisites

1. Clone the repository:
```bash
git clone [email protected]:line/line-bot-mcp-server.git
cd line-bot-mcp-server
```

2. Install dependencies:
```bash
npm install
```

3. Build the project:
```bash
npm run build
```

### Run the Inspector

After building the project, you can start the MCP Inspector:

```bash
npx @modelcontextprotocol/inspector node dist/index.js
```

This will start the MCP Inspector interface where you can interact with the LINE Bot MCP Server tools and test their functionality.

## Versioning

This project respects semantic versioning
Expand Down