MCP Server
growi-mcp-server
Official MCP Server to integrate with GROWI APIs.
3
GitHub Stars
8/23/2025
Last Updated
MCP Server Configuration
1{
2 "name": "growi",
3 "command": "npx",
4 "args": [
5 "@growi/mcp-server"
6 ],
7 "env": {
8 "GROWI_BASE_URL": "https://your-growi-instance.com",
9 "GROWI_API_TOKEN": "your_growi_api_token"
10 }
11}
JSON11 lines
README Documentation
@growi/mcp-server
A 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.
Key Features
- 🔍 GROWI page search and retrieval
- 📝 Page management
- 🏷️ Tag management
- 📋 Comment management
- 🔗 Share link management
Supported GROWI Versions
- GROWI v7.3.x or higher recommended
- *GROWI v7.3.x is scheduled for release in 2025Q2
- Some features are available on GROWI v7.2.x and below
- GROWI API
MCP Server Configuration
{
"mcpServers": {
"growi": {
"command": "npx",
"args": ["@growi/mcp-server"],
"env": {
"GROWI_BASE_URL": "https://your-growi-instance.com",
"GROWI_API_TOKEN": "your_growi_api_token"
}
}
}
}
Available Tools (Features)
Page Management
searchPages
- Search pages by keywordscreatePage
- Create a new pageupdatePage
- Update an existing pagedeletePages
- Delete pages (bulk operation supported)duplicatePage
- Duplicate a page (including child pages)renamePage
- Change page name and pathgetPage
- Get a page datagetPageInfo
- Get detailed page informationgetRecentPages
- Get list of recently updated pagesgetPageListingRoot
- Get root page listgetPageListingChildren
- Get child pages of specified pagepageListingInfo
- Get summary information of page listingspublishPage
/unpublishPage
- Set page publish/unpublish status
Tag Management
getPageTag
- Get tags of a pageupdateTag
- Update tags of a pagegetTagList
- Get list of tagssearchTags
- Search tags
Comments & Discussions
getComments
- Get comments of a page
Revision Management
listRevisions
- Get page edit historygetRevision
- Get details of a specific revision
Share Links
createShareLink
- Create a share linkgetShareLinks
- Get share links of a pagedeleteShareLinks
- Delete share linksdeleteShareLinkById
- Delete a specific share link
User Information
getUserRecentPages
- Get recent pages of a specific user
Configuration Options
Environment Variables
Variable Name | Required | Description | Default Value |
---|---|---|---|
GROWI_BASE_URL | ✅ | Base URL of GROWI instance | - |
GROWI_API_TOKEN | ✅ | GROWI API access token | - |
Developer Information
Requirements
- Node.js 18 or higher
- pnpm (recommended)
- GROWI instance (for development and testing)
Getting Started
- Clone the repository
git clone https://github.com/growilabs/growi-mcp-server.git
cd growi-mcp-server
- Install dependencies
pnpm install
- Set up environment variables
cp .env.example .env.local
# Edit .env.local to enter GROWI connection information
- Start the development server
# Test with MCP CLI
pnpm dev:cli
# Develop with MCP Inspector
pnpm dev:inspect
Build and Test
# Build
pnpm build
# Lint
pnpm lint
# Run in production
pnpm start
MCP Server Configuration
- Build
pnpm build
- MCP Server Configuration
{
"mcpServers": {
"growi": {
"command": "node",
"args": ["/Users/username/projects/growi-mcp-server/dist/index.js"],
"env": {
"GROWI_BASE_URL": "https://your-growi-instance.com",
"GROWI_API_TOKEN": "your_growi_api_token"
}
}
}
}
[!NOTE] Set the absolute path to the built output in "args"
Troubleshooting
When unable to connect to GROWI
- Check connectivity
curl -v http://app:3000/_api/v3/healthcheck
- If the
app
hostname cannot be resolved, check the devcontainer network and verify it includesgrowi_devcontainer_default
- The
.devcontainer/devcontainer.json
file sets--network
inrunArgs
, so rebuilding the container should apply this setting - To add manually, run the following:
- Run
docker network
command on the docker host machine
docker network connect growi_devcontainer_default growi-mcp-server-dev
- Run
- The
Contributing
Contributions to the project are welcome!
How to Contribute
- Issue Reports: Bug reports and feature requests via GitHub Issues
- Pull Requests:
- Fork and create a branch
- Implement changes
- Add tests (if applicable)
- Create a pull request
Development Guidelines
- Coding Standards: Use Biome
- Commit Messages: Follow Conventional Commits
License
This project is released under the MIT License.
Related Links
- GROWI Official Site - Open source wiki platform
- Model Context Protocol - Standard protocol for AI and tool integration
- GROWI SDK TypeScript - GROWI API TypeScript SDK
- FastMCP - MCP server development framework
Notice
This MCP server is under development. APIs may change without notice. Please test thoroughly before using in production environments.
Quick Install
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source