Mediawiki MCP Adapter

🚀 MediaWiki适配器

这是一个自定义的**模型上下文协议（MCP）**适配器，可用于与MediaWiki和WikiBase API进行交互。借助该适配器，你能够利用MCP框架以程序化的方式获取和编辑MediaWiki页面。

🚀 快速开始

要使用这个MediaWiki适配器，你可以按照以下步骤进行操作：

1. 克隆仓库：

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

2. 安装依赖项：

npm install

3. 构建项目：

npm run build

4. 运行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",
});

资源 - 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：

你可以通过server.configure()方法覆盖这些默认值。

贡献指南

若要为项目做贡献，请按照以下步骤操作：

1. 克隆仓库。
2. 创建功能分支。
3. 提交更改。
4. 推送到远程仓库。
5. 创建拉取请求。

请确保在提交代码之前阅读并遵循项目的贡献规范和代码风格指南。

📄 许可证

项目受[此处指定的许可证](# license)约束。请参阅LICENSE文件以获取详细信息。

👨‍💻 作者

• Lucas - 来源

此文档由[此处指定的构建工具或框架](# framework)生成。