Userful Mcps

🚀 有用的模型庫

這是一個用於構建和使用有用模型的庫，它提供了多種工具和服務，能幫助用戶完成各類任務。

🚀 快速開始

本庫可助力你輕鬆構建和使用有用模型，下面將為你介紹安裝和使用方法。

✨ 主要特性

• 提供多種工具和服務，協助用戶完成各類任務。
• 具備清晰的項目結構，便於開發與維護。
• 提供測試方法，保障代碼質量。

📦 安裝指南

你可以通過以下命令安裝該庫：

pip install useful-models

💻 使用示例

基礎用法

創建一個簡單的服務器

from mcp import Server, Tool, TextContent, stdio_server
import logging

class MyService:
    def __init__(self):
        # 初始化服務時的資源準備
        pass

    def my_function(self, param1: str, param2: int) -> dict:
        # 實現具體的業務邏輯
        logging.info(f"執行 my_function，參數為 {param1=}, {param2=}")
        result_content = f"結果：成功處理了 {param1} 和 {param2}"
        return {"content": result_content}

async def serve() -> None:
    logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(levelname)s - %(message)s')
    server = Server("mcp-my-service")
    service = MyService()

    @server.list_tools()
    async def list_tools() -> list[Tool]:
        logging.info("list_tools 被調用")
        return [
            Tool(
                name="my.tool",
                description="我的工具描述",
                inputSchema={"type": "object", "properties": {"param1": {"type": "string"}, "param2": {"type": "integer"}}, "required": ["param1", "param2"]}
            ),
        ]

    @server.call_tool()
    async def call_tool(name: str, arguments: dict) -> list[TextContent]:
        logging.info(f"call_tool 被調用，工具名稱為 {name=}, 參數為 {arguments=}")
        try:
            if name == "my.tool":
                param1 = arguments.get("param1")
                param2 = arguments.get("param2")
                if not (param1 and param2):
                    raise ValueError("缺少必需的參數")

                result = service.my_function(param1, int(param2))
                logging.info(f"工具執行成功，結果為 {result=}")
                return [TextContent(type="text", text=json.dumps(result))]
            else:
                logging.warning(f"請求了未知的工具：{name}")
                raise ValueError(f"未知工具：{name}")
        except Exception as e:
            logging.error(f"執行工具 {name} 時出錯，錯誤信息為：{e}", exc_info=True)
            error_payload = json.dumps({"error": str(e)})
            return [TextContent(type="text", text=error_payload)]

    options = server.create_initialization_options()
    logging.info("開始啟動 MCP 服務器...")
    async with stdio_server() as (read_stream, write_stream):
        await server.run(read_stream, write_stream, options)
    logging.info("MCP 服務器已停止。")

def main():
    try:
        asyncio.run(serve())
    except KeyboardInterrupt:
        logging.info("服務器已被用戶中斷。")

if __name__ == "__main__":
    # 允許通過直接運行腳本進行調試
    main()

項目結構

• useful-models/: 包含所有模型和工具的實現。
• tests/: 存放測試文件，確保代碼質量。

📚 詳細文檔

測試方法

從根目錄運行以下命令即可執行測試：

pytest tests/

⚠️ 重要提示

請確保已安裝 pytest。

📄 許可證

本項目遵循 MIT 許可證。具體條款如下：

• 允許任何人自由使用、複製、修改和分發此軟件。
• 修改後的版本必須在文檔中明確標註。
• 無需支付任何費用。

🔗 貢獻指南

歡迎各位貢獻代碼！請按照以下步驟操作：

1. Fork 項目倉庫。
2. 在自己的分支上進行開發。
3. 提交代碼並創建 Pull Request。

讓我們一起將這個模型庫變得更加有用！