Growi/mcp Server

1- [日本語 🇯🇵](./README_JP.md)
2 
3# @growi/mcp-server
4 
5[![npm version](https://badge.fury.io/js/%40growi%2Fmcp-server.svg)](https://badge.fury.io/js/%40growi%2Fmcp-server)
6[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7 
8A Model Context Protocol (MCP) server that connects AI models to GROWI wiki content. Enables LLMs to search and retrieve information from your organization's knowledge base for accurate, context-aware responses. Supports connections to multiple GROWI apps.
9 
10## Key Features
11 
12- 🔍 **GROWI page search and retrieval**
13- 📝 **Page management**
14- 🏷️ **Tag management**
15- 📋 **Comment management**
16- 🔗 **Share link management**
17 
18## Supported GROWI Versions
19 
20- GROWI v7.3.x or higher recommended
21- Some features are also available starting from GROWI v7.2.5 and later
22- [GROWI API](https://docs.growi.org/en/api/)
23 
24 
25## MCP Server Configuration
26 
27Supports simultaneous connections to multiple GROWI apps. Each app is configured using numbered environment variables.
28 
29### Single App Configuration Example
30```json
31{
32  "mcpServers": {
33    "growi": {
34      "command": "npx",
35      "args": ["@growi/mcp-server"],
36      "env": {
37        "GROWI_APP_NAME_1": "main",
38        "GROWI_BASE_URL_1": "https://your-growi-instance.com",
39        "GROWI_API_TOKEN_1": "your_growi_api_token"
40      }
41    }
42  }
43}
44```
45 
46### Multiple Apps Configuration Example
47```json
48{
49  "mcpServers": {
50    "growi": {
51      "command": "npx",
52      "args": ["@growi/mcp-server"],
53      "env": {
54        "GROWI_DEFAULT_APP_NAME": "staging",
55 
56        "GROWI_APP_NAME_1": "production",
57        "GROWI_BASE_URL_1": "https://wiki.example.com",
58        "GROWI_API_TOKEN_1": "token_for_production",
59 
60        "GROWI_APP_NAME_2": "staging",
61        "GROWI_BASE_URL_2": "https://wiki-staging.example.com",
62        "GROWI_API_TOKEN_2": "token_for_staging",
63        
64        "GROWI_APP_NAME_3": "development",
65        "GROWI_BASE_URL_3": "https://wiki-dev.example.com",
66        "GROWI_API_TOKEN_3": "token_for_development"
67      }
68    }
69  }
70}
71```
72 
73## Available Tools (Features)
74 
75### Page Management
76- `searchPages` - Search pages by keywords
77- `createPage` - Create a new page
78- `updatePage` - Update an existing page
79- `deletePages` - Delete pages (bulk operation supported)
80- `duplicatePage` - Duplicate a page (including child pages)
81- `renamePage` - Change page name and path
82- `getPage` - Get a page data
83- `getPageInfo` - Get detailed page information
84- `getRecentPages` - Get list of recently updated pages
85- `getPageListingRoot` - Get root page list
86- `getPageListingChildren` - Get child pages of specified page
87- `pageListingInfo` - Get summary information of page listings
88- `publishPage` / `unpublishPage` - Set page publish/unpublish status
89 
90### Tag Management
91- `getPageTag` - Get tags of a page
92- `updateTag` - Update tags of a page
93- `getTagList` - Get list of tags
94- `searchTags` - Search tags
95 
96### Comments & Discussions
97- `getComments` - Get comments of a page
98 
99### Revision Management
100- `listRevisions` - Get page edit history
101- `getRevision` - Get details of a specific revision
102 
103### Share Links
104- `createShareLink` - Create a share link
105- `getShareLinks` - Get share links of a page
106- `deleteShareLinks` - Delete share links
107- `deleteShareLinkById` - Delete a specific share link
108 
109### User Information
110- `getUserRecentPages` - Get recent pages of a specific user
111 
112 
113## Configuration Options
114 
115### Environment Variables
116 
117| Variable Name | Required | Description | Default Value |
118|---------------|----------|-------------|---------------|
119| `GROWI_APP_NAME_{N}` | ✅ | GROWI app identifier name (N is an integer) | - |
120| `GROWI_BASE_URL_{N}` | ✅ | Base URL of GROWI instance (N is an integer) | - |
121| `GROWI_API_TOKEN_{N}` | ✅ | GROWI API access token (N is an integer) | - |
122| `GROWI_DEFAULT_APP_NAME` | ❌ | Default app name to use | First configured app |
123 
124### Multiple Apps Configuration Notes
125- Use integer values (1, 2, 3...) for each app configuration (sequential numbering is not required)
126- Combination of `GROWI_APP_NAME_N`, `GROWI_BASE_URL_N`, and `GROWI_API_TOKEN_N` is required
127- App names, base URLs, and API tokens must each be unique
128- If `GROWI_DEFAULT_APP_NAME` is omitted, the first configured app becomes the default
129- The app specified in `GROWI_DEFAULT_APP_NAME` will be used as the default app when the LLM does not explicitly include an app name in the prompt
130 
131 
132## Developer Information
133 
134### Requirements
135- Node.js 18 or higher
136- pnpm (recommended)
137- GROWI instance (for development and testing)
138 
139### Getting Started
140 
1411. Clone the repository
142```bash
143git clone https://github.com/growilabs/growi-mcp-server.git
144cd growi-mcp-server
145```
146 
1472. Install dependencies
148```bash
149pnpm install
150```
151 
1523. Set up environment variables
153```bash
154cp .env.example .env.local
155# Edit .env.local to enter GROWI connection information
156```
157 
1584. Start the development server
159```bash
160# Test with MCP CLI
161pnpm dev:cli
162 
163# Develop with MCP Inspector
164pnpm dev:inspect
165```
166 
167### Build and Test
168```bash
169# Build
170pnpm build
171 
172# Lint
173pnpm lint
174 
175# Run tests
176pnpm test
177 
178# Run tests with coverage
179pnpm test:coverage
180 
181# Run in production
182pnpm start
183```
184 
185### MCP Server Configuration
186 
1871. Build
188```bash
189pnpm build
190```
191 
1922. MCP Server Configuration (Single App)
193```json
194{
195  "mcpServers": {
196    "growi": {
197      "command": "node",
198      "args": ["/Users/username/projects/growi-mcp-server/dist/index.js"],
199      "env": {
200        "GROWI_APP_NAME_1": "main",
201        "GROWI_BASE_URL_1": "https://your-growi-instance.com",
202        "GROWI_API_TOKEN_1": "your_growi_api_token"
203      }
204    }
205  }
206}
207```
208 
2093. MCP Server Configuration (Multiple Apps)
210```json
211{
212  "mcpServers": {
213    "growi": {
214      "command": "node",
215      "args": ["/Users/username/projects/growi-mcp-server/dist/index.js"],
216      "env": {
217        "GROWI_DEFAULT_APP_NAME": "production",
218 
219        "GROWI_APP_NAME_1": "production",
220        "GROWI_BASE_URL_1": "https://wiki.example.com",
221        "GROWI_API_TOKEN_1": "production_token",
222 
223        "GROWI_APP_NAME_2": "staging",
224        "GROWI_BASE_URL_2": "https://wiki-staging.example.com",
225        "GROWI_API_TOKEN_2": "staging_token"
226      }
227    }
228  }
229}
230```
231 
232> [!NOTE]
233> Set the absolute path to the built output in "args"
234 
235### Troubleshooting
236 
237### When unable to connect to GROWI
2381. Check connectivity
239    ```bash
240    curl -v http://app:3000/_api/v3/healthcheck
241    ```
2422. If the `app` hostname cannot be resolved, check the devcontainer network and verify it includes `growi_devcontainer_default`
243    - The `.devcontainer/devcontainer.json` file sets `--network` in `runArgs`, so rebuilding the container should apply this setting
244    - To add manually, run the following:
245        - Run `docker network` command on the docker host machine
246        ```bash
247        docker network connect growi_devcontainer_default growi-mcp-server-dev
248        ```
249 
250 
251### Contributing
252 
253Contributions to the project are welcome!
254 
255#### How to Contribute
2561. **Issue Reports**: Bug reports and feature requests via [GitHub Issues](https://github.com/growilabs/growi-mcp-server/issues)
2572. **Pull Requests**:
258   - Fork and create a branch
259   - Implement changes
260   - Add tests (if applicable)
261   - Create a pull request
262 
263#### Development Guidelines
264- **Coding Standards**: Use [Biome](https://biomejs.dev/)
265- **Commit Messages**: Follow [Conventional Commits](https://www.conventionalcommits.org/)
266 
267## License
268 
269This project is released under the [MIT License](./LICENSE).
270 
271---
272 
273## Related Links
274 
275- **[GROWI Official Site](https://growi.org/)** - Open source wiki platform
276- **[Model Context Protocol](https://modelcontextprotocol.io/)** - Standard protocol for AI and tool integration
277- **[GROWI SDK TypeScript](https://github.com/growilabs/growi-sdk-typescript)** - GROWI API TypeScript SDK
278- **[FastMCP](https://github.com/punkpeye/fastmcp)** - MCP server development framework
279 
280---
281 
282**Notice**
283 
284This MCP server is under development. APIs may change without notice. Please test thoroughly before using in production environments.
285