使用说明
后台MCP服务器
MCP(模型上下文协议)服务器,提供与您的实例交互的工具 后台 软件目录。此服务器允许您列出实体、获取实体详细信息以及从Backstage实例查看祖先信息。
特性
- 列出实体:查询Backstage实体,可选择按类型和命名空间进行筛选
- 获取实体:检索特定实体的详细信息
- 获取实体血统:查看任何实体的祖先链
- 承载令牌身份验证:Backstage API的安全身份验证支持
安装
此MCP服务器设计为在Docker容器中运行。您可以通过 Docker MCP注册表 或者在本地运行它。
先决条件
- Docker桌面
- Python 3.11+(用于本地开发)
使用Docker运行
docker build -t backstage-mcp .
docker run -e BACKSTAGE_BEARER_TOKEN=your_token_here -e BACKSTAGE_API_BASE=https://backstage.example.com/API/catalog backstage-mcp
配置
服务器需要以下环境变量:
BACKSTAGE_API_BASE(可选):Backstage API目录终结点的基本URL。BACKSTAGE_BEARER_TOKEN(可选):Backstage API身份验证的承载令牌
工具
list_entities
在Backstage中列出实体,可以选择按种类和命名空间进行筛选。
参数:
kind(可选):实体类型过滤器(例如,“组件”、“API”、“系统”)namespace(可选):命名空间筛选器limit(可选):要返回的最大实体数(默认值:10)
get_entity
按种类、命名空间和名称获取Backstage实体。
参数:
kind(必需):实体类型(例如“组件”、“API”、“系统”)namespace(必需):实体命名空间name(必填):实体名称
get_entity_ancestry
获取Backstage实体的祖先信息。
参数:
kind(必填):实体类型namespace(必需):实体命名空间name(必填):实体名称
set_bearer_token
在运行时为Backstage API请求设置承载令牌。
参数:
token(必需):Backstage API身份验证的承载令牌
发展
本地设置
- 克隆此存储库:
git clone https://github.com/timinter/backstage-mcp-server.git
cd backstage-mcp-server
- 安装依赖项:
pip install -r requirements.txt
- 运行服务器:
python backstage.py
构建Docker镜像
docker build -t backstage-mcp .
贡献
该项目是 Docker MCP注册表.贡献:
- 分叉MCP注册表存储库
- 跟随 贡献指南
- 提交拉取请求
许可证
根据Apache许可证2.0版授权。看 许可证 了解详情。
