Mediawiki MCP Adapter

🚀 媒體維基適配器

這是一個自定義的**模型上下文協議（MCP）**適配器，可用於與MediaWiki和WikiBase API進行交互。藉助該適配器，你能夠通過MCP框架以程序化的方式獲取和編輯MediaWiki頁面。

🚀 快速開始

此適配器允許你使用MCP框架程序化地獲取和編輯MediaWiki頁面。以下是使用前的準備步驟：

1. 克隆倉庫：

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

2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

4. 配置適配器：

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

5. 啟動MCP服務器：

node build/index.js

✨ 主要特性

• 獲取MediaWiki頁面的內容。
• 使用新的內容（及可選摘要）編輯MediaWiki頁面。
• 可配置不同MediaWiki和WikiBase實例的API基礎URL。

📦 安裝指南

環境需求

• Node.js（v16或更高版本）
• TypeScript（用於開發）
• 啟用API訪問的MediaWiki實例

安裝步驟

1. 克隆倉庫：

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

2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

💻 使用示例

基礎用法

配置適配器

您可以配置適配器以使用自定義的MediaWiki和WikiBase API端點：

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

啟動MCP服務器

使用以下命令運行MCP服務器：

node build/index.js

高級用法

getPageContent

獲取MediaWiki頁面的內容。

• 輸入模式：

{
  "title": "string"
}

• 輸出模式：

{
  "content": "string"
}

示例用法：

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

editPage

使用新內容編輯MediaWiki頁面。

• 輸入模式：

{
  "title": "string",
  "content": "string",
  "summary": "string（可選）"
}

• 輸出模式：

{
  "success": "boolean"
}

示例用法：

const response = await server.callTool("editPage", {
  title: "Main Page",
  content: "新內容...",
  summary: "更新頁面內容"
});
console.log(response.success);

📚 詳細文檔

開發

運行開發模式

要以開發模式運行項目，請使用：

npm run dev

檢查代碼質量

要檢查代碼質量，可以運行：

npm run lint

測試

要在項目中運行測試，可以執行：

npm test

配置

默認情況下，適配器使用以下API基礎URL：

• mediaWikiAPIBase: https://api.wikipedia.org/wikipedia/v1
• wikiBaseAPIBase: https://wikibase.example.com 您可以通過server.configure()方法覆蓋這些默認值。

貢獻指南

要為項目做貢獻，請按照以下步驟操作：

1. 克隆倉庫。
2. 創建功能分支。
3. 提交更改。
4. 推送到遠程倉庫。
5. 創建拉取請求。 請確保在提交代碼之前閱讀並遵循項目的貢獻規範和代碼風格指南。

📄 許可證

項目受[此處指定的許可證](# license)約束。請參閱LICENSE文件以獲取詳細信息。

👨‍💻 作者

• Lucas - 來源

此文檔由[此處指定的構建工具或框架](# framework)生成。

項目狀態