LINE Bot MCP Server

1[日本語版 READMEはこちら](README.ja.md)
2 
3# LINE Bot MCP Server
4 
5[![npmjs](https://badge.fury.io/js/%40line%2Fline-bot-mcp-server.svg)](https://www.npmjs.com/package/@line/line-bot-mcp-server)
6 
7[Model Context Protocol (MCP)](https://github.com/modelcontextprotocol) server implementation that integrates the LINE Messaging API to connect an AI Agent to the LINE Official Account.
8 
9![](/assets/demo.png)
10 
11> [!NOTE]
12> This repository is provided as a preview version. While we offer it for experimental purposes, please be aware that it may not include complete functionality or comprehensive support.
13 
14## Tools
15 
161. **push_text_message**
17   - Push a simple text message to a user via LINE.
18   - **Inputs:**
19     - `userId` (string?): The user ID to receive a message. Defaults to DESTINATION_USER_ID. Either `userId` or `DESTINATION_USER_ID` must be set.
20     - `message.text` (string): The plain text content to send to the user.
212. **push_flex_message**
22   - Push a highly customizable flex message to a user via LINE.
23   - **Inputs:**
24     - `userId` (string?): The user ID to receive a message. Defaults to DESTINATION_USER_ID. Either `userId` or `DESTINATION_USER_ID` must be set.
25     - `message.altText` (string): Alternative text shown when flex message cannot be displayed.
26     - `message.contents` (any): The contents of the flex message. This is a JSON object that defines the layout and components of the message.
27     - `message.contents.type` (enum): Type of the container. 'bubble' for single container, 'carousel' for multiple swipeable bubbles.
283. **broadcast_text_message**
29   - Broadcast a simple text message via LINE to all users who have followed your LINE Official Account.
30   - **Inputs:**
31     - `message.text` (string): The plain text content to send to the users.
324. **broadcast_flex_message**
33   - Broadcast a highly customizable flex message via LINE to all users who have added your LINE Official Account.
34   - **Inputs:**
35     - `message.altText` (string): Alternative text shown when flex message cannot be displayed.
36     - `message.contents` (any): The contents of the flex message. This is a JSON object that defines the layout and components of the message.
37     - `message.contents.type` (enum): Type of the container. 'bubble' for single container, 'carousel' for multiple swipeable bubbles.
385. **get_profile**
39   - Get detailed profile information of a LINE user including display name, profile picture URL, status message and language.
40   - **Inputs:**
41     - `userId` (string?): The ID of the user whose profile you want to retrieve. Defaults to DESTINATION_USER_ID.
426. **get_message_quota**
43   - Get the message quota and consumption of the LINE Official Account. This shows the monthly message limit and current usage.
44   - **Inputs:**
45     - None
467. **get_rich_menu_list**
47   - Get the list of rich menus associated with your LINE Official Account.
48   - **Inputs:**
49     - None
508. **delete_rich_menu**
51   - Delete a rich menu from your LINE Official Account.
52   - **Inputs:**
53     - `richMenuId` (string): The ID of the rich menu to delete.
549. **set_rich_menu_default**
55    - Set a rich menu as the default rich menu.
56    - **Inputs:**
57      - `richMenuId` (string): The ID of the rich menu to set as default.
5810. **cancel_rich_menu_default**
59    - Cancel the default rich menu.
60    - **Inputs:**
61      - None
6211. **create_rich_menu**
63    - Create a rich menu based on the given actions. Generate and upload an image. Set as default.
64    - **Inputs:**
65      - `chatBarText` (string): Text displayed in chat bar, also used as rich menu name.
66      - `actions` (array): The actions of the rich menu. You can specify minimum 1 to maximum 6 actions. Each action can be one of the following types:
67        - `postback`: For sending a postback action
68        - `message`: For sending a text message
69        - `uri`: For opening a URL
70        - `datetimepicker`: For opening a date/time picker
71        - `camera`: For opening the camera
72        - `cameraRoll`: For opening the camera roll
73        - `location`: For sending the current location
74        - `richmenuswitch`: For switching to another rich menu
75        - `clipboard`: For copying text to clipboard
76 
77## Installation (Using npx)
78 
79requirements:
80- Node.js v20 or later
81 
82### Step 1: Create LINE Official Account
83 
84This MCP server utilizes a LINE Official Account. If you do not have one, please create it by following [this instructions](https://developers.line.biz/en/docs/messaging-api/getting-started/#create-oa). 
85 
86If you have a LINE Official Account, enable the Messaging API for your LINE Official Account by following [this instructions](https://developers.line.biz/en/docs/messaging-api/getting-started/#using-oa-manager).
87 
88### Step 2: Configure AI Agent
89 
90Please add the following configuration for an AI Agent like Claude Desktop or Cline. 
91 
92Set the environment variables or arguments as follows:
93 
94- `CHANNEL_ACCESS_TOKEN`: (required) Channel Access Token. You can confirm this by following [this instructions](https://developers.line.biz/en/docs/basics/channel-access-token/#long-lived-channel-access-token).
95- `DESTINATION_USER_ID`: (optional) The default user ID of the recipient. If the Tool's input does not include `userId`, `DESTINATION_USER_ID` is required. You can confirm this by following [this instructions](https://developers.line.biz/en/docs/messaging-api/getting-user-ids/#get-own-user-id).
96 
97```json
98{
99  "mcpServers": {
100    "line-bot": {
101      "command": "npx",
102      "args": [
103        "@line/line-bot-mcp-server"
104      ],
105      "env": {
106        "CHANNEL_ACCESS_TOKEN" : "FILL_HERE",
107        "DESTINATION_USER_ID" : "FILL_HERE"
108      }
109    }
110  }
111}
112```
113 
114## Installation (Using Docker)
115 
116### Step 1: Create LINE Official Account
117 
118This MCP server utilizes a LINE Official Account. If you do not have one, please create it by following [this instructions](https://developers.line.biz/en/docs/messaging-api/getting-started/#create-oa).
119 
120If you have a LINE Official Account, enable the Messaging API for your LINE Official Account by following [this instructions](https://developers.line.biz/en/docs/messaging-api/getting-started/#using-oa-manager).
121 
122 
123### Step 2: Build line-bot-mcp-server image
124 
125Clone this repository:
126 
127```
128git clone git@github.com:line/line-bot-mcp-server.git
129```
130 
131Build the Docker image:
132 
133```
134docker build -t line/line-bot-mcp-server .
135```
136 
137### Step 3: Configure AI Agent
138 
139Please add the following configuration for an AI Agent like Claude Desktop or Cline.
140 
141Set the environment variables or arguments as follows:
142 
143- `mcpServers.args`: (required) The path to `line-bot-mcp-server`.
144- `CHANNEL_ACCESS_TOKEN`: (required) Channel Access Token. You can confirm this by following [this instructions](https://developers.line.biz/en/docs/basics/channel-access-token/#long-lived-channel-access-token).
145- `DESTINATION_USER_ID`: (optional) The default user ID of the recipient. If the Tool's input does not include `userId`, `DESTINATION_USER_ID` is required.
146You can confirm this by following [this instructions](https://developers.line.biz/en/docs/messaging-api/getting-user-ids/#get-own-user-id).
147 
148 
149```json
150{
151  "mcpServers": {
152    "line-bot": {
153      "command": "docker",
154      "args": [
155        "run",
156        "-i",
157        "--rm",
158        "-e",
159        "CHANNEL_ACCESS_TOKEN",
160        "-e",
161        "DESTINATION_USER_ID",
162        "line/line-bot-mcp-server"
163      ],
164      "env": {
165        "CHANNEL_ACCESS_TOKEN" : "FILL_HERE",
166        "DESTINATION_USER_ID" : "FILL_HERE"
167      }
168    }
169  }
170}
171```
172 
173## Local Development with Inspector
174 
175You can use the MCP Inspector to test and debug the server locally.
176 
177### Prerequisites
178 
1791. Clone the repository:
180```bash
181git clone git@github.com:line/line-bot-mcp-server.git
182cd line-bot-mcp-server
183```
184 
1852. Install dependencies:
186```bash
187npm install
188```
189 
1903. Build the project:
191```bash
192npm run build
193```
194 
195### Run the Inspector
196 
197After building the project, you can start the MCP Inspector:
198 
199```bash
200npx @modelcontextprotocol/inspector node dist/index.js \
201  -e CHANNEL_ACCESS_TOKEN="YOUR_CHANNEL_ACCESS_TOKEN" \
202  -e DESTINATION_USER_ID="YOUR_DESTINATION_USER_ID"
203```
204 
205This will start the MCP Inspector interface where you can interact with the LINE Bot MCP Server tools and test their functionality.
206 
207## Versioning
208 
209This project respects semantic versioning
210 
211See http://semver.org/
212 
213## Contributing
214 
215Please check [CONTRIBUTING](./CONTRIBUTING.md) before making a contribution.
216