Growi

You are running a Model Context Protocol (MCP) server that connects AI models to your GROWI wiki content. It enables language models to search, retrieve, and manage knowledge from multiple GROWI apps, providing accurate, context-aware responses and streamlined page management features.

How to use

You interact with the MCP server through an MCP client to perform operations like searching pages, retrieving content, managing pages, tags, comments, and share links. The server supports connecting to one or more GROWI apps, so you can keep content from multiple wikis in sync with your AI workflows. Use the client to send queries for specific pages or collections of pages, and to request actions such as creating, updating, or publishing pages. The MCP server routes your requests to the appropriate GROWI instance and returns structured results that your AI tool can consume.

How to install

Prerequisites you need before installation are Node.js 18 or higher and a preferred package manager such as pnpm.

Step 1: Clone the project

git clone https://github.com/growilabs/growi-mcp-server.git
cd growi-mcp-server

Step 2: Install dependencies

pnpm install

Step 3: Set up environment variables

cp .env.example .env.local
# Edit .env.local to enter GROWI connection information

Step 4: Start the development server

# Test with MCP CLI
pnpm dev:cli

# Develop with MCP Inspector
pnpm dev:inspect

Step 5: Build and start for production

pnpm build
pnpm start

MCP Server configuration examples

The MCP server can connect to a GROWI app either as a single app or as multiple apps. Use the following stdio configuration to run the MCP server locally. The path in the example is the built output you run after building the project.

{
  "mcpServers": {
    "growi": {
      "command": "node",
      "args": ["/Users/username/projects/growi-mcp-server/dist/index.js"],
      "env": {
        "GROWI_APP_NAME_1": "main",
        "GROWI_BASE_URL_1": "https://your-growi-instance.com",
        "GROWI_API_TOKEN_1": "your_growi_api_token"
      }
    }
  }
}

Advanced configuration: multiple GROWI apps

If you operate more than one GROWI app, provide distinct app names, base URLs, and API tokens for each app in the MCP configuration.

{
  "mcpServers": {
    "growi": {
      "command": "node",
      "args": ["/Users/username/projects/growi-mcp-server/dist/index.js"],
      "env": {
        "GROWI_DEFAULT_APP_NAME": "production",

        "GROWI_APP_NAME_1": "production",
        "GROWI_BASE_URL_1": "https://wiki.example.com",
        "GROWI_API_TOKEN_1": "production_token",

        "GROWI_APP_NAME_2": "staging",
        "GROWI_BASE_URL_2": "https://wiki-staging.example.com",
        "GROWI_API_TOKEN_2": "staging_token",

        "GROWI_APP_NAME_3": "development",
        "GROWI_BASE_URL_3": "https://wiki-dev.example.com",
        "GROWI_API_TOKEN_3": "development_token"
      }
    }
  }
}

Security and access

Keep API tokens and access credentials secure. Use environment variables to avoid hard-coding sensitive values in source control. Restrict network access to the MCP server and follow your organization’s security guidelines for API tokens and GROWI access.

Troubleshooting

If you cannot connect to GROWI, verify basic connectivity first and check DNS resolution for the GROWI host. For example, you can perform a health check against the GROWI API to confirm availability.

If the dev container cannot resolve the app hostname, ensure the container network includes the proper network for your development environment. If needed, connect the container’s network to the host network used by your development setup.

Notes

This MCP server supports simultaneous connections to multiple GROWI apps. Ensure each app’s name, base URL, and API token are unique and correctly configured. If a default app name is not specified, the first configured app is used as the default.

Available tools

searchPages

Search pages by keywords to retrieve relevant content from GROWI apps.

createPage

Create a new page in a GROWI app.

updatePage

Update an existing page in a GROWI app.

deletePages

Delete pages in bulk from a GROWI app.

duplicatePage

Duplicate a page including its child pages.

renamePage

Rename a page and its path within GROWI.

getPage

Retrieve a page’s content and metadata.

getPageInfo

Get detailed information about a specific page.

getRecentPages

Fetch recently updated pages.

getPageListingRoot

Get the root list of pages.

getPageListingChildren

Get child pages under a specified page.

pageListingInfo

Get summary information about page listings.

publishPage

Publish a page to make it visible.

unpublishPage

Unpublish a page to hide it.

getPageTag

Retrieve tags for a page.

updateTag

Update tags on a page.

getTagList

List all tags.

searchTags

Search tags across pages.

getComments

Retrieve comments for a page.

listRevisions

List a page’s revision history.

getRevision

Get details of a specific revision.

createShareLink

Create a shareable link for a page.

getShareLinks

Retrieve share links for a page.

deleteShareLinks

Delete share links for a page.

deleteShareLinkById

Delete a specific share link by ID.

getUserRecentPages

Fetch recent pages accessed by a user.