growi-mcp-server

The growi-mcp-server is a Model Context Protocol (MCP) server that connects AI models to GROWI wiki content. This tool enables LLMs to search and retrieve information from your organization's knowledge base for accurate, context-aware responses. Implemented in TypeScript, it offers features such as page management, tag management, and comment management for GROWI. This allows users to efficiently manage information and enhance interactions with AI.

GitHub Stars

6

User Rating

Not Rated

Favorites

0

Views

34

Forks

4

Issues

1

Installation
Difficulty
Intermediate
Estimated Time
10-20 minutes
Requirements
Node.js 18以上
pnpm推奨
+1 more

Installation

Installation

Prerequisites

Please specify required software and versions:
Node.js: 18.0.0 or higher
pnpm: Recommended
GROWI instance: For development and testing

Installation Steps

1. Clone Repository

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

2. Install Dependencies

bash
pnpm install

3. Configure MCP Server

Edit claude_desktop_config.json to add the MCP server:
json
{
  "mcpServers": {
    "growi": {
      "command": "npx",
      "args": ["@growi/mcp-server"],
      "env": {
        "GROWI_BASE_URL": "https://your-growi-instance.com",
        "GROWI_API_TOKEN": "your_growi_api_token"
      }
    }
  }
}

4. Start Server

bash
npm start

Troubleshooting

Common Issues

Issue: Server won't start Solution: Check Node.js version and reinstall dependencies. Issue: Invalid GROWI API token Solution: Verify GROWI settings and ensure the correct API token is used.

Configuration

Configuration

Basic Configuration

MCP Server Setup

Edit ~/.config/claude-desktop/claude_desktop_config.json (macOS/Linux) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
json
{
  "mcpServers": {
    "growi": {
      "command": "npx",
      "args": ["@growi/mcp-server"],
      "env": {
        "GROWI_BASE_URL": "https://your-growi-instance.com",
        "GROWI_API_TOKEN": "your_growi_api_token"
      }
    }
  }
}

Environment Variables

Set the following environment variables as needed:
bash
export GROWI_BASE_URL="https://your-growi-instance.com"
export GROWI_API_TOKEN="your_growi_api_token"

Security Settings

Store API keys in environment variables or secure configuration files
Set appropriate file access permissions
Adjust logging levels

Configuration Example

Basic Configuration

json
{
  "mcpServers": {
    "growi": {
      "command": "npx",
      "args": ["@growi/mcp-server"],
      "env": {
        "GROWI_BASE_URL": "https://your-growi-instance.com",
        "GROWI_API_TOKEN": "your_growi_api_token"
      }
    }
  }
}

Examples

Examples

Basic Usage

Here are basic usage examples for the MCP server:

Programmatic Usage

javascript
// JavaScript example (Node.js)
const { MCPClient } = require('@modelcontextprotocol/client');

const client = new MCPClient();
await client.connect();

// Execute tool
const result = await client.callTool('searchPages', {
  keyword: 'specific keyword'
});

console.log(result);

Advanced Examples

API Integration

python

Python example

import requests import json def call_mcp_tool(tool_name, params): response = requests.post( 'http://localhost:3000/mcp/call', json={ 'tool': tool_name, 'parameters': params } ) return response.json()

Usage example

result = call_mcp_tool('getRecentPages', {}) print(result)

Use Cases

Search for specific pages within GROWI and have the AI generate responses based on their content.
Create new pages and allow the AI to provide information related to those pages.
Retrieve recent pages of a specific user for the AI to analyze that user's activity.
Update page tags and enable the AI to organize information based on those tags.

Additional Resources