许可证检查工具

LicenseGuard是一款帮助用户轻松理解项目依赖软件许可证的工具,提供许可证检查、清晰识别和可理解报告等功能。

  • by cassiama
  • Python
  • 本地部署
  • 更新于
在 GitHub 查看 cassiama/LicenseGuard-MCP

使用说明

LicenseGuard(MCP)

LicenseGuard旨在帮助您轻松理解项目依赖关系的软件许可证。

以下是它提供的内容:

  • 轻松的许可证检查:只需提供您的项目 requirements.txt,LicenseGuard将为您分析。
  • 清晰的许可证标识:系统会识别与您的依赖关系相关的软件许可证。
  • 可理解的报告:获取一份简单的JSON报告,详细说明找到的许可证以及置信度得分。
  • 简单集成:您可以通过用户友好的API与LicenseGuard交互,以提交依赖项列表并检索分析结果。

LicenseGuard简化了检查软件许可证的过程,让您快速清晰地了解项目的许可情况。


关于此存储库

此存储库包含 MCP服务器,它负责处理和分析项目依赖关系的许可证。

要点:

  1. MCP服务器依赖于现有的 REST服务器 功能。REST服务器在单独的存储库中可用(https://github.com/cassiama/LicenseGuard-API).
  2. 在启动MCP服务器之前,您必须确保REST服务器正在运行。MCP服务器与REST服务器通信以获取和处理数据。
  3. 有关REST服务器的更多详细信息,请参阅其存储库: REST服务器存储库.
  4. 有一个样品 代理 其中包括此存储库中可用的MCP客户端: LicenseGuard 人工智能。您可以使用此示例代理来测试MCP服务器。
  5. 或者,您可以使用任何现成的MCP服务器测试仪来测试MCP服务器。

快速入门

在你的机器上运行它的最快、最简单的方法是使用Docker。

需求

简言之:

  • 在本地计算机上安装Docker桌面/引擎。
  • 确保REST服务器正在运行且可访问。
  • 设置调用后端API服务器的URL所需的环境变量。

确保你的机器上安装了Docker桌面(或Docker引擎)。如果没有,请从以下网址下载 Docker网站.

环境变量

您需要提供以下内容,否则服务器将无法运行,您将看到错误:

  • BACKEND_URL_HOST:指后端REST API服务器运行的主机。您的主机应该是HTTP/HTTPS域(例如。, http://localhost).
  • BACKEND_URL_PORT:指REST服务器运行的端口。您的端口应该是0到65535之间的数字(16位数字) 不 与计算机上已使用的端口冲突。

用法

为了本指南的目的,我们假设您想从Docker Hub中提取映像。但是,如果你愿意,你也可以从GitHub容器注册表(GHCR)下载图像。

下载Docker镜像

运行以下命令从您计算机上的Docker Hub下载镜像:

docker pull licenseguard/license-guard:mcp-latest

注意:如果您需要特定版本,请拉取 licenseguard/license-guard:mcp-v{x.y.z} 图像代替(x.y.z 指的是 语义版本号).

注:对于那些更喜欢GHCR的人,请替换任何提及 licenseguard/license-guard 随着 ghcr.io/cassiama/license-guard 对于下面的任何命令,你都会做得很好。 👍🏿


在本地构建Docker镜像

如果你想从源代码构建Docker镜像,请按照以下步骤操作:

  1. 将存储库克隆到本地计算机:

    git clone https://github.com/your-repo/LicenseGuard-MCP.git
    cd LicenseGuard-MCP
    
  2. 构建Docker镜像:

    docker build -t licenseguard/license-guard:mcp-latest .
    

    注意:更换 mcp-latest 具有特定版本标签(例如。, mcp-v1.0.0)如果需要的话。

  3. 运行Docker镜像:

    • 随着 .env 文件:
      docker run -p 8000:8000 --env-file .env licenseguard/license-guard:mcp-latest
      
    • 对于环境变量:
      docker run -p 8000:8000 -e BACKEND_URL_HOST=http://localhost -e BACKEND_URL_PORT=80 licenseguard/license-guard:mcp-latest
      

服务器运行后,您可以访问以下位置的所有MCP相关资源 http://localhost:8000/mcp.


运行MCP服务器

要运行MCP服务器,请执行以下步骤:

  1. 启动REST服务器:

    • 克隆REST服务器存储库并按照其设置说明进行操作。
    • 确保REST服务器正在运行,并且可以在中指定的主机和端口上访问 BACKEND_URL_HOST 和 BACKEND_URL_PORT 环境变量。
  2. 运行MCP服务器:

    • 使用Docker镜像或如上所述在本地构建它。
    • 确保环境变量指向正在运行的REST服务器。

两台服务器都运行后,您可以访问以下位置的所有MCP相关资源 http://localhost:8000/mcp.


测试MCP服务器

您可以使用以下方法之一测试MCP服务器:

  1. 使用样品试剂:

    • 带有MCP客户端的示例代理可在 LicenseGuard-AI 仓库.
    • 克隆存储库并按照说明设置和运行代理。
    • 代理将与MCP服务器交互并提供测试结果。
  2. 使用现成的MCP服务器测试仪:

    • 您可以使用任何标准的MCP服务器测试工具来验证MCP服务器的功能。
    • 确保测试仪配置为在正确的主机和端口与MCP服务器通信。