MediaWiki MCP adapter

What is MediaWiki-MCP-adapter?

MediaWiki-MCP-adapter is a custom Model Context Protocol (MCP) adapter designed to facilitate programmatic interaction with MediaWiki and WikiBase APIs. It allows users to fetch and edit MediaWiki pages using the MCP framework.

How to use MediaWiki-MCP-adapter?

To use MediaWiki-MCP-adapter, you first need to install it by cloning the repository, installing dependencies via npm install, and building the project with npm run build. You can then configure the adapter with custom MediaWiki and WikiBase API endpoints using server.configure() and start the MCP server using node build/index.js.

Example Usage:

Fetching Page Content:

const response = await server.callResource("getPageContent", {
  title: "Main Page",
});
console.log(response.content);

Editing a Page:

const response = await server.callTool("editPage", {
  title: "Main Page",
  content: "Updated content for the page.",
  summary: "Updated via MediaWikiAdapter",
});
console.log(response.success ? "Edit successful" : "Edit failed");

Key Features of MediaWiki-MCP-adapter

• Fetch Page Content: Retrieve the content of any MediaWiki page.
• Edit MediaWiki Pages: Modify MediaWiki pages with new content and an optional summary.
• Configurable API Base URLs: Easily switch between different MediaWiki and WikiBase instances by configuring their API base URLs.

Use Cases of MediaWiki-MCP-adapter

• Automated Content Management: Develop scripts to automatically update or create MediaWiki pages.
• Data Extraction: Programmatically extract content from MediaWiki for analysis or integration with other systems.
• WikiBot Development: Build bots that interact with MediaWiki and WikiBase for various tasks.
• Integration with Applications: Integrate MediaWiki functionalities into custom applications.

FAQ from MediaWiki-MCP-adapter

Q: What are the requirements to run MediaWiki-MCP-adapter? A: You need Node.js (v16 or later), TypeScript (for development), and a MediaWiki instance with API access enabled.

Q: Can I customize the MediaWiki and WikiBase API endpoints? A: Yes, you can configure the adapter to use custom API base URLs for both MediaWiki and WikiBase.

Q: Are there any tests included with the project? A: Currently, no tests are implemented, but you can add them to the test directory and run them using npm test.

Q: What license is MediaWiki-MCP-adapter released under? A: The project is licensed under the LGPL-3.0-or-later license.

MediaWikiAdapter

A custom Model Context Protocol (MCP) adapter for interacting with MediaWiki and WikiBase APIs. This adapter allows you to fetch and edit MediaWiki pages programmatically using the MCP framework.

Features

• Fetch the content of a MediaWiki page.
• Edit a MediaWiki page with new content and an optional summary.
• Configurable API base URLs for different MediaWiki and WikiBase instances.

Requirements

• Node.js (v16 or later)
• TypeScript (for development)
• MediaWiki instance with API access enabled

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/mediawikiadapter.git
   cd mediawikiadapter

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

Usage

Configure the Adapter

You can configure the adapter to use custom MediaWiki and WikiBase API endpoints:

server.configure({
  mediaWikiAPIBase: "https://my.mediawiki.instance/api.php",
  wikiBaseAPIBase: "https://my.wikibase.instance/api.php",
});

Start the MCP Server

Run the MCP server using the following command:

node build/index.js

Resources

getPageContent

Fetches the content of a MediaWiki page.

• Input Schema:

  {
    "title": "string"
  }

• Output Schema:

  {
    "content": "string"
  }
  

Example Usage:

const response = await server.callResource("getPageContent", {
  title: "Main Page",
});
console.log(response.content);

---

Tools

editPage

Edits a MediaWiki page with new content.

• Input Schema:

  {
    "title": "string",
    "content": "string",
    "summary": "string (optional)"
  }

• Output Schema:

  {
    "success": "boolean"
  }

Example Usage:

const response = await server.callTool("editPage", {
  title: "Main Page",
  content: "Updated content for the page.",
  summary: "Updated via MediaWikiAdapter",
});
console.log(response.success ? "Edit successful" : "Edit failed");

---

Development

Run in Development Mode

To run the project in development mode with TypeScript:

npm run dev

Linting

Run the linter to check for code quality:

npm run lint

Testing

Currently, no tests are implemented. You can add tests to the test directory and run them using:

npm test

---

Configuration

The adapter uses the following default API base URLs:

• MediaWiki API Base: https://en.wikipedia.org/w/api.php
• WikiBase API Base: https://www.wikidata.org/w/api.php

You can override these defaults using the server.configure() method.

---

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Submit a pull request with a detailed description of your changes.

---

License

This project is licensed under the LGPL-3.0-or-later license. See the LICENSE file for details.

---

Author

Created by Luca Mauri.