article
README
🚀 品牌获取 MCP 服务器
此 MCP 服务器作为大型语言模型 (LLM) 应用与 Brandfetch API 间的桥梁,助力 AI 助手搜索品牌并获取全面品牌信息。它通过实现模型上下文协议,将 Brandfetch 的品牌数据功能无缝融入 LLM 驱动的应用中。
🚀 快速开始
此 MCP 服务器充当大型语言模型 (LLM) 应用程序与 Brandfetch API 之间的桥梁,使 AI 助手能够搜索品牌并检索全面的品牌信息。通过实现模型上下文协议,此服务器将 Brandfetch 的品牌数据功能无缝集成到 LLM 驱动的应用程序中。
✨ 主要特性
- 品牌搜索:按名称搜索品牌并获取基本信息。
- 详细品牌信息:检索包括标志、颜色、字体和公司详情在内的全面品牌数据。
- 字段筛选:请求特定信息以优化响应大小和处理。
- 交互式提示:内置提示引导用户正确使用 API。
- 类型安全实现:完全基于类型的 Python 代码库,支持现代异步。
- 健壮的错误处理:全面的错误处理和日志记录。
📦 安装指南
先决条件
- Python 3.9 或更高版本
- Brandfetch API 凭证(API 密钥和客户端 ID)
使用 uv(推荐)
# 创建并导航到新项目目录
uv init brandfetch-mcp
cd brandfetch-mcp
# 克隆此仓库
git clone https://github.com/VincentSolconBraze/brandfetch-mcp.git .
# 添加依赖项
uv add "mcp[cli]" httpx python-dotenv
# 开发用途
uv add --dev pytest pytest-asyncio pytest-cov ruff pyright pre-commit
使用 pip
# 克隆此仓库
git clone https://github.com/VincentSolconBraze/brandfetch-mcp.git
cd brandfetch-mcp
# 安装依赖项
pip install "mcp[cli]" httpx python-dotenv
# 开发用途
pip install pytest pytest-asyncio pytest-cov ruff pyright pre-commit
🔧 配置
- 根据示例创建
.env文件:
cp .env.example .env
- 将 Brandfetch API 凭证添加到
.env文件中:
BRANDFETCH_API_KEY=your_api_key
BRANDFETCH_CLIENT_ID=your_client_id
您可以在 Brandfetch 上创建账户并获取凭证。
💻 使用示例
基础用法
# 搜索品牌
search_brands(query="apple", limit=5)
# 获取特定品牌信息
get_brand_info(brand_id="12345")
高级用法
# 结合字段筛选
get_brand_info(brand_id="67890", fields=["name", "logo"])
运行方式
通过 Claude Desktop 运行
# 在 Claude Desktop 中运行
claudius run
通过 MCP Inspector 运行
# 在 MCP Inspector 中运行
inspect
直接执行
# 直接在终端中运行
python3 main.py
可用工具及参数说明
-
search_brands:按品牌名称搜索品牌并获取基本信息。
query:要搜索的品牌关键词。limit:返回的结果数量限制。
-
get_brand_info:检索指定品牌的详细信息。
brand_id:品牌的唯一标识符。fields:需要检索的具体字段(可选)。
📚 详细文档
🧪 测试
运行测试套件
# 运行所有测试
pytest tests/
生成覆盖率报告
# 生成覆盖率报告
coverage run -m pytest tests/ && coverage html
🤝 贡献
🔒 安全
- 安全报告:如发现任何安全问题,请联系 [security@brandfetch.com]
📄 许可证
此项目由 MIT 许可证授权。
MIT 许可证内容
扫码联系在线客服