界面已本地化;技能介绍与说明文档按所选语言由 AI 自动翻译,代码、命令、路径和专业术语保留原文,以原作者文档为准。
探索技能
文档与办公 · SKILL.md

xwiki-mcp-connector

xwiki-mcp-connector

【文档与办公】MCP connector for XWiki – enables AI-powered wiki management, space organization, and collaborative documentation through Claude

独立 GitHub 快照 · 自动分类 · 以原作者文档为准

技能说明

GitHub

name: xwiki-mcp-connector description: "MCP connector for XWiki – enables AI-powered wiki management, space organization, and collaborative documentation through Claude" license: LGPL tags: ["dev","wiki","mcp","xwiki","documentation"] difficulty: intermediate time_to_master: "4-8 weeks" version: "1.0.0"

Xwiki MCP Connector

Overview

This skill enables Claude to interact with Xwiki through the Model Context Protocol (MCP). It provides a bridge between Claude's AI capabilities and Xwiki's REST API, allowing natural language control of Xwiki operations, intelligent automation, and AI-powered assistance for Xwiki workflows.

When to Use This Skill

  • Page and space creation via natural language
  • XWiki scripting and macro development
  • Application creation with App Within Minutes
  • User and group management
  • Extension installation and configuration

Architecture

┌─────────────┐     ┌─────────────────┐     ┌──────────────────┐
│   Claude     │────▶│   MCP Server    │────▶│   Xwiki            │
│   (Client)   │◀────│   (TypeScript)  │◀────│   (REST API      )│
└─────────────┘     └─────────────────┘     └──────────────────┘

Core Concepts

MCP Server Setup

The connector implements an MCP server that exposes Xwiki operations as tools Claude can invoke. The server translates natural language intentions into REST API calls.

Key Endpoints/Interfaces

/rest/wikis/:wiki/spaces, /rest/wikis/:wiki/pages, /rest/wikis/:wiki/search, /rest/wikis/:wiki/classes

Implementation

// Xwiki MCP Server Implementation
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { z } from "zod";

const server = new McpServer({
  name: "xwiki-mcp-connector",
  version: "1.0.0",
});

// Tool: List/Query Resources
server.tool(
  "list_resources",
  "List and query Xwiki resources with optional filters",
  {
    query: z.string().optional().describe("Search query or filter"),
    limit: z.number().optional().describe("Max results to return"),
  },
  async ({ query, limit }) => {
    // Call Xwiki REST API
    const response = await fetch(`${BASE_URL}/rest/wikis/:wiki/spaces`, {
      headers: { "Authorization": `Bearer ${API_KEY}` },
    });
    const data = await response.json();
    return {
      content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
    };
  }
);

// Tool: Create Resource
server.tool(
  "create_resource",
  "Create a new resource in Xwiki",
  {
    name: z.string().describe("Resource name"),
    config: z.object({}).passthrough().optional().describe("Resource configuration"),
  },
  async ({ name, config }) => {
    const response = await fetch(`${BASE_URL}/rest/wikis/:wiki/spaces`, {
      method: "POST",
      headers: {
        "Authorization": `Bearer ${API_KEY}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ name, ...config }),
    });
    const data = await response.json();
    return {
      content: [{ type: "text", text: `Created: ${JSON.stringify(data)}` }],
    };
  }
);

// Tool: Analyze/Report
server.tool(
  "analyze",
  "AI-powered analysis of Xwiki data",
  {
    type: z.string().describe("Analysis type"),
    timeframe: z.string().optional().describe("Time range for analysis"),
  },
  async ({ type, timeframe }) => {
    // Fetch data and provide AI analysis
    const response = await fetch(`${BASE_URL}/rest/wikis/:wiki/spaces`, {
      headers: { "Authorization": `Bearer ${API_KEY}` },
    });
    const data = await response.json();
    return {
      content: [{ type: "text", text: JSON.stringify(data, null, 2) }],
    };
  }
);

// Start server
const transport = new StdioServerTransport();
await server.connect(transport);

Claude Desktop Configuration

{
  "mcpServers": {
    "xwiki-mcp-connector": {
      "command": "node",
      "args": ["path/to/xwiki-mcp-connector/index.js"],
      "env": {
        "XWIKI_API_KEY": "your-api-key",
        "XWIKI_BASE_URL": "https://your-instance-url"
      }
    }
  }
}

Best Practices

  1. Authentication: Store API keys securely using environment variables; never hardcode credentials
  2. Rate Limiting: Implement request throttling to respect Xwiki API rate limits
  3. Error Handling: Provide clear, actionable error messages for common failure scenarios
  4. Pagination: Handle paginated responses for large datasets efficiently
  5. Caching: Cache frequently accessed read-only data to reduce API calls
  6. Security: Validate all inputs before passing to the Xwiki API; sanitize outputs
  7. Logging: Log all API interactions for debugging and audit purposes

Example Prompts

"Create a structured space for the engineering handbook with templates for RFCs, ADRs, and runbooks"

Security Considerations

  • All API credentials must be stored as environment variables
  • Implement input validation and sanitization for all tool parameters
  • Use HTTPS for all API communications
  • Follow the principle of least privilege for API token permissions
  • Audit log all write operations for compliance tracking

Resources

Changelog

VersionDateChanges
1.0.02026-04-01Initial MCP connector skill

Part of SkillGalaxy - 10,000+ comprehensive skills for AI-assisted development.

我的收藏