办公室
](pyproject.toml)           
办公室 (*铋*tsight *R*吃 *关于*triever）是一个模型上下文协议（MCP）服务器，它将BitSight 订阅LLM友好工具。它将400多个原始端点隐藏在精心策划的强类型工作流表面后面， 自动处理临时订阅，并作为零安装的uv应用程序发布，以便分析师和代理可以运行它 任何地方。
为什么要使用BiRRe？
- 统一的工作流程 LLM获得了一个一致的搜索、评级、入职和订阅卫生工具集。
- 更安全的操作 –自动文件夹定位、模拟预览和重试感知助手使BitSight数据保持整洁
同时防止意外搅拌。
- 值得信赖的发布 –严格的类型（版权）、基于属性的测试、签名工件和SBOM使
在受监管的环境中依赖BiRRe。
你需要的
| 要求 | 详细信息 |
|---|---|
| BitSight访问 | API密钥，对要查询的公司/文件夹具有访问权限。 |
| 运行时 | Python 3.13+(uv 跨Linux/macOS/Windows自动安装）。 |
| 网络 | HTTPS到 api.bitsighttech.com 实时数据；支持自定义CA。 |
| 客户端 | 任何兼容MCP的LLM或代理平台（GPT、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, 然后开始 uv run birre 在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 （确切）。 | 返回匹配项(全局唯一标识符、名称、域名、符合条件的公司数量）。 |
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连接、订阅和工具 检查BitSight的测试环境（暂存）。当调用时 --offline，只运行本地配置和日志检查。
# Run the full diagnostics against the default BitSight testing endpoint.
uv run birre selftest
# Target the production API to exercise real subscription logic and permissions.
uv run birre selftest --production成功运行后退出 0.故障返回 1，以及部分结果 警告（例如，离线模式下的可选工具间隙）返回 2. 期待偶尔 403 Access Denied 使用BitSight测试时的响应 环境。
文件、支持和贡献
- docs/CLI.md –完整的命令参考、配置助手、选项表。
- docs/ROADMAP.md –当前版本摘要和即将到来的里程碑。
- docs/ARCHITECTURE.md –FastMCP分层和BitSight集成设计。
- docs/SECURITY_VERIFICATION.md 验证已签名的版本（Sigstore、SBOM、PyPI）。
- docs/api/ –精心策划的BitSight端点概述（v1/v2）。
- 贡献.md –开发工作流程、pytest/pyright说明、PR期望。
- 安全.md –报告流程和支持的发布政策。
欢迎问题和PR；捐款根据 无许可证.
免责声明
办公室 (*铋*tsight *R*吃 *关于*triever）是 不隶属于、不受BitSight Technologies，股份有限公司认可或赞助。
- 该项目由开源社区独立开发和维护
- “Bitsight”是Bitsight Technologies，股份有限公司的注册商标。
- 此集成按“原样”提供，不提供任何保证
或BitSight Technologies，股份有限公司的官方支持。
- 使用适用于遵守BitSight条款的集成场景。