Table of Contents

基本能力

产品定位

NTeALan REST APIs MCP Server 是一个模块化、可扩展的 MCP 服务器，用于管理 NTeALan REST APIs 的字典数据、文章和用户贡献。

核心功能

• 字典管理：创建、更新、删除和检索字典及其元数据。
• 文章管理：管理字典中的文章，包括统计和筛选功能。
• 贡献管理：跟踪和管理用户对文章和字典的贡献。
• 可扩展的 MCP 服务器：轻松添加新资源和工具。
• 异步支持：基于 fastmcp 和 aiohttp 构建，具有高性能。
• OpenAPI 风格的资源注册：通过 URI 和标签注册资源和工具。

适用场景

• 需要统一管理多语言字典数据的应用。
• 需要跟踪用户贡献的字典或文章管理系统。
• 需要高性能、可扩展的 REST API 后端服务。

工具列表

• 资源工具：用于管理字典、文章和贡献的 CRUD 操作。
• 实用工具：如统计、筛选等功能。

常见问题解答

• 开发端点可能偶尔不可用，建议通过 GitHub Issues 反馈问题。

使用教程

使用依赖

• Python 3.11+
• uv
• aiohttp
• pydantic
• fastmcp
• aiodns
• python-dotenv

安装依赖命令：

pip install aiohttp pydantic fastmcp aiodns python-dotenv

安装教程

克隆仓库并安装依赖：

git clone https://github.com/Levis0045/ntealan-apis-mcp-server.git
cd ntealan-apis-mcp-server
pip install .

使用 uv 安装依赖：

uv sync

调试方式

启动 MCP 服务器：

python -m ntealanmcp -t stdio

或使用 uv：

ntealanmcp -t stdio

服务器默认运行在 http://127.0.0.1:8000/sse。

运行示例

uv run examples/run_client_resources.py -t sse -e prod -s 8
uv run examples/run_client_tools.py -t stdio -e local -s 0

Docker 部署

构建 Docker 镜像：

docker build -t ntealan-mcp-server .

启动服务：

docker compose up --build -d

连接 Smithery

安装 MCP CLI：

uv add "mcp[cli]"

连接 MCP 客户端：

import mcp
from mcp.client.websocket import websocket_client

async def main():
    async with websocket_client(url) as streams:
        async with mcp.ClientSession(*streams) as session:
            await session.initialize()
            tools_result = await session.list_tools()
            print(f"Available tools: {', '.join([t.name for t in tools_result.tools])}")

if __name__ == "__main__":
    import asyncio
    asyncio.run(main())

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。