BiRRe(Bitsight Rating Retriever)是一个模型上下文协议(MCP)服务器,它将BitSight订阅转换为适合大型语言模型(LLM)使用的工具。它隐藏了400多个原始端点,并提供了一个精心策划、强类型的流程界面,自动处理临时订阅,并作为零安装的uv应用程序发布,因此分析员和代理可以在任何地方运行它。
| 要求 | 详情 |
|---|---|
| BitSight 访问 | 具有您打算查询的公司/文件夹权限的API密钥。 |
| 运行时 | Python 3.13+(uv自动安装于Linux/macOS/Windows)。 |
| 网络 | HTTPS到api.bitsighttech.com以获取实时数据;支持自定义CA。 |
| 客户端 | 任何兼容MCP的LLM或代理平台(GPTs、LangChain、本地MCP客户端等)。 |
导出您的BitSight API密钥。
使用uvx启动MCP服务器(无需安装的PyPI运行):
export BITSIGHT_API_KEY="your-bitsight-api-key"
uvx birre
将您的MCP兼容客户端/LLM指向服务器端点。从company_search开始以获取GUID,然后调用get_company_rating或运行风险管理工作流。
使用--help查看每个可用命令、子命令和选项的帮助信息。
此README的其余部分假设您已进行本地检出:
通过git clone https://github.com/boecht/birre创建一个本地副本,然后在BiRRe目录中使用uv run birre开始。
配置层按以下顺序合并:config.toml → config.local.toml → 环境变量 → CLI标志。使用以下命令检查或验证有效设置:
uv run birre config show
uv run birre config validate --config differently/named/config.toml
参见docs/CLI.md了解完整的选项表和config.toml中的注释默认值。
通过--context、BIRRE_CONTEXT或[runtime].context切换上下文。工具名称直接映射到MCP工具调用。
standard + risk_manager)| 工具 | 输入 | 描述 |
|---|---|---|
company_search | 公司name(模糊匹配)或domain(精确匹配)。 | 返回匹配项(GUID,名称,域名,符合条件的公司数量)。 |
get_company_rating | 公司GUID。 | 编译评级负载:当前值/颜色,8周和1年趋势,优先发现事项以及评级图例。(如有必要,自动订阅和取消订阅) |
risk_manager工具| 工具 | 输入 | 描述 |
|---|---|---|
company_search_interactive | name或domain(与company_search相同)。 | 丰富搜索结果,包括当前评级、员工人数、订阅状态等信息,以及母公司相同的信息。 |
manage_subscriptions | action(add/delete),GUIDs列表,可选folder,dry_run。 | 验证意图,解决/创建添加的文件夹,然后执行订阅更改。返回干运行预览或应用摘要(添加/删除/错误,文件夹元数据)。 |
request_company | 逗号分隔的domains(最多255个),可选folder,dry_run。 | 去除重复提交,报告已请求的域,并在可用时提交BitSight批量入职CSV(否则使用遗留回退)。包含每个域的成功/失败摘要和文件夹信息。 |
在连接客户端之前,使用内置的自测来检查您的设置是否正常。该命令镜像run启动序列,报告解析的配置,并对BitSight的测试环境(暂存环境)进行连接性、订阅和工具检查。当使用--offline调用时,仅运行本地配置和日志检查。
# 对默认的BitSight测试端点进行全面诊断。
uv run birre selftest
# 目标生产API以执行真实的订阅逻辑和权限。
uv run birre selftest --production
成功的运行退出代码为0。失败返回1,部分结果带有警告(例如,在离线模式下缺少可选工具)返回2。使用BitSight的测试环境时,偶尔会收到403 Access Denied响应。
欢迎提出问题和PR;贡献发布在无版权下。
BiRRe(Bitsight Rating Retriever)不隶属于、得到BitSight Technologies, Inc.的认可或赞助。