CAST成像MCP服务器
概述
CAST成像MCP服务器通过模型上下文协议(MCP)公开全面的软件智能,弥合了AI代理和真实软件架构之间的差距。它允许用户通过提示AI代理来了解他们的应用程序、事务、依赖关系、质量模式和架构结构。
此服务为AI代理提供了对应用程序的理解,从投资组合级库存到粒度对象关系。无论您是在探索数据库模式、分析事务流、调查质量问题,MCP服务器都能提供精确的分页数据,从而做出明智的架构决策。
用例
- 投资组合层面的探索:列出CAST Imaging中可用的应用程序,并提供有关它们的详细信息。
- 应用架构分析:探索不同层次的架构图,并可视化系统结构。
- 事务和数据流映射:分析交易,跟踪数据实体交互网络,探索复杂对象和排序。
- 质量和安全见解:识别应用程序中的漏洞、云就绪障碍和结构性缺陷。
- 数据库模式探索:跨应用程序浏览数据库表、列、关系和约束。
- 对象级调查:搜索对象及其属性并分析调用者/被调用者关系。
______________________________________________________________________
目录
______________________________________________________________________
先决条件
必需
- Linux 系统与 码头工人 安装并运行。
- CAST成像API 可从此主机访问的服务
- MCP感知客户端 (例如,VS Code中的GitHub Copilot、Claude Desktop)
- CAST成像API密钥 (根据您的成像用户配置文件生成)
可选的
- CA签名的TLS证书+私钥 对于HTTPS
下载
- 下载CAST Imaging MCP服务器的安装程序
MCP服务器应在Linux系统上运行。CAST Imaging‑API可以在相同或不同的Linux机器上运行。
______________________________________________________________________
快速开始
- 验证成像API 直播:
curl -H "x-api-key: " http://{CONTROL_PANEL_HOST}:8090/imaging/apis/rest/ready
# expected: true- 提取 安装程序压缩。
- 配置
config/app.config和.env. - 开始 服务器与
./run.sh. - 配置客户端 (VS Code Copilot或Claude)与您的服务器URL。
- 测试 查询(见下面的示例)。
______________________________________________________________________
CAST成像MCP服务器的安装
1) 解压缩安装程序
com.castsoftware.imaging.mcpserver.docker.1.0.2-funcrel/
├─ config/
│ └─ app.config
├─ nginx/
│ └─ nginx.conf
├─ .env # hidden; use `ls -a`
├─ docker-compose.yml
├─ docker-compose.https.yml
├─ run.sh
├─ README.md
└─ copilot-instructions.md2) 验证CAST成像API
确保控制面板/注册表可访问,并且Imaging‑API已准备就绪(请参阅快速入门步骤#1)。
3) 配置服务器
编辑 config/app.config:
HOST_CONTROL_PANEL="your-control-panel-host" # REQUIRED: Control Panel service registry host/IP
PORT_CONTROL_PANEL=8098 # Default Control Panel registry port
IMAGING_PAGE_SIZE=1000 # Internal fetch batch size
IMAGING_DISPLAY_PAGE_SIZE=20 # Page size in responses
IMAGING_CODE=False # Source code access via MCP (security sensitive)
DEBUG_MODE=true # Debug mode to see the activity in logs
HTTPS_ENABLED=false # Turn on if serving HTTPS (see below)将暴露的端口设置为 .env (隐藏文件):
MCP_SERVER_PORT=8282提示: 在Linux上,以点开头的文件(如.env)隐藏。使用ls -a查看。
4) 开始
chmod +x run.sh
./run.sh这将启动Docker Compose堆栈和MCP服务器。
______________________________________________________________________
配置参考
HOST_CONTROL_PANEL (必填)
违约: 无(用户需要提供值)\ 说明: 运行控制面板服务的计算机的IP或主机名。
这是Imaging用来注册和发现其内部服务的服务注册表。安装Imaging时,它会自动部署。您应该输入运行映像控制面板服务的Linux机器的IP地址。
PORT_CONTROL_PANEL
违约: 8098\ 说明: 控制面板注册表端口。
IMAGING_PAGE_SIZE
违约: 1000\ 说明: 设置MCP服务器每次请求获取的记录数(内部批处理)。调整吞吐量。
IMAGING_DISPLAY_PAGE_SIZE
违约: 20\ 说明: 设置在面向用户的响应中每页显示多少条记录。调整用户体验。
IMAGING_CODE
违约: False\ 说明: 控制代理是否可以通过MCP服务器访问源代码。
它是 false 默认情况下,代理通常在开放存储库上工作。启用它可能会将源代码暴露给任何具有MCP访问权限的人,使其成为潜在的安全风险,特别是对于像Claude desktop这样没有直接回购访问权限的客户端。
DEBUG_MODE
违约: true\ 说明: 调试模式将在日志中显示活动。当设置为true时,它将显示所选择的工具、调用的API以及每个用户提示的结果。当设置为false时,它将只显示所选择的工具和调用的相应API。
HTTPS_ENABLED
违约: false\ 说明: 应设置为 true 如果在客户端和MCP服务器之间使用HTTPS。
______________________________________________________________________
正在运行(HTTP/HTTPS)
HTTP(默认)
- 保持
HTTPS_ENABLED=false(故障值)config/app.config. - 从开始
./run.sh(这将使用docker-compose.yml).
HTTPS(可选,建议用于生产)
- 集
HTTPS_ENABLED=true在config/app.config. - 创建
certificates/安装程序根目录中的文件夹。在此内部,添加具有以下名称的证书和私钥文件:
- certificate.pem (服务器证书) - private_key.pem (私钥)
- 从开始
./run.sh(这将使用docker-compose.https.yml+Nginx TLS终止)。
HTTPS模式为应用程序提供了 Nginx.用正确的名称放置证书。
______________________________________________________________________
Windows安装
本节提供了在Windows系统上安装和配置CAST成像MCP服务器的详细步骤。
Windows的先决条件
- 视窗 系统
- CAST成像API 服务正在运行且可访问
- MCP感知客户端 (例如,VS Code中的GitHub Copilot、Claude Desktop)
- CAST成像API密钥 (根据您的成像用户配置文件生成)
1) 下载和提取
- 下载windows的安装程序包。
- 将zip文件解压缩到您的首选位置
- 导航到提取的目录
包装内容:
com.castsoftware.imaging.mcpserver.__MCP_VERSION__*/
├─ mcpserver/
├─ tools/
├─ configuration.conf
├─ mcp-server-installer.bat
└─ README.md2) 验证CAST成像API
确保控制面板/注册表可访问,并且Imaging‑API已准备就绪:
curl -H "x-api-key: "
http://{HOSTNAME_CONTROL_PANEL}:8090/rest/ready
# expected: true3) 配置服务器
编辑 configuration.conf 使用您的环境设置:
HOSTNAME_CONTROL_PANEL="your-control-panel-host" # Required: IP or hostname of Control Panel server
PORT_CONTROL_PANEL=8098 # Default Control Panel registry port
MCP_SERVER_PORT=8282 # Default MCP server port
INSTALL_DIR=C:\Program Files\Cast\Imaging-MCP-Server # Default installation location
CONFIG_DIR=C:\ProgramData\CAST\Imaging-MCP-Server # Default config files location
IMAGING_PAGE_SIZE=1000 # Records per internal request
IMAGING_DISPLAY_PAGE_SIZE=20 # Records per response page
IMAGING_CODE=False # Enable source code access (security consideration)4) 作为Windows服务安装
使用批处理脚本运行安装:
mcp-server-installer.bat --install configuration.conf这将MCP服务器作为Windows服务安装。成功安装后,您将看到一个名为的Windows服务 “CAST成像MCP服务器” 在您的服务列表中。
5) 验证安装
检查服务是否正在运行:
- 打开 服务 (services.msc)
- 寻找 “CAST成像MCP服务器”
- 确保状态为 “跑步”
Windows特定操作
更新MCP服务器
要更新现有安装,请执行以下操作:
mcp-server-installer.bat --update更新不需要更改配置。
卸载MCP服务器
要完全卸下MCP服务器:
mcp-server-installer.bat --uninstall这将删除Windows服务并清理所有与MCP相关的文件。
获得帮助
对于可用命令:
mcp-server-installer.bat --help可用命令:
mcp-server-installer.bat --install configuration.conf : Install CAST Imaging MCP server
mcp-server-installer.bat --update : Update CAST Imaging MCP server
mcp-server-installer.bat --uninstall : Uninstall CAST Imaging MCP server
mcp-server-installer.bat --help : Display help messageWindows故障排除
| 问题 | 可能原因 | 解决方案 |
|---|---|---|
| 服务无法启动 | 配置错误 | 检查 %CONFIG_DIR%/setup-config/app.config |
| 连接被拒绝 | 服务未运行 | 重新启动“CAST成像MCP服务器”服务 |
| 安装失败 | 权限不足 | 以管理员身份运行安装程序 |
______________________________________________________________________
VS代码+GitHub副本设置
本节提供了将CAST成像MCP服务器与Github Copilot连接的详细步骤。
1) 在VS代码上安装GitHub Copilot
- 打开“扩展”视图(Ctrl+Shift+X或Cmd+Shift+X)。
- 搜索“GitHub Copilot”并单击安装。
- 出现提示时登录GitHub
2) 生成CAST成像API密钥
- 登录您的CAST影像
- 导航到您的个人资料部分。
- 生成一个新的API密钥(根据您在下一步中的需要安全地复制并保存此密钥)
3) 创建MCP配置(.vscode/mcp.json)
- 打开VS Code中的任何文件夹,并在其根目录中创建.vcode文件夹。在里面,创建mcp.json文件。
{
"inputs": [
{
"id": "imaging-key",
"type": "promptString",
"description": "CAST Imaging API Key"
}
],
"servers": {
"imaging": {
"type": "http",
"url": "http:///mcp/",
"headers": {
"x-api-key": "${input:imaging-key}"
}
}
}
}对于HTTPS:更改http://到https://.
4) (备选)手动注册流程
如果VS Code没有自动选择服务器:
- 打开 副驾驶聊天 → 齿轮图标→ 选择可用于聊天的工具
- +添加更多工具… → +添加MCP服务器… → 选择 超文本传输协议
- 进入
http(s):///mcp/并确认 - VS代码写入
.vscode/copilot/mcp.json→ 添加标题块:
"my-mcp-server-xxxx": {
"url": "http:///mcp/",
"headers": {
"x-api-key": "${input:imaging-key}"
}
}5) Copilot项目说明
复制 copilot-instructions.md 通过创建一个名为 .github 然后粘贴 copilot-instructions.md 这将有助于代理提供更好的响应。
______________________________________________________________________
验证和测试查询
连接检查
# MCP container running
docker ps | grep mcp-server
# Imaging‑APIs health
curl -H "x-api-key: " http://{CONTROL_PANEL_HOST}:8090/imaging/apis/rest/ready在Copilot/Claude尝试
List all applications
List 5 transactions for application
List available applications datagraphs
List applications insights______________________________________________________________________
工具集和工具
服务器将功能组织为 工具集.
可用工具集
| 工具集 | 说明 |
|---|---|
Portfolio Tools | 投资组合级探索:列出应用程序、比较指标、跨系统扫描热点。 |
Applications Tools | 应用程序级分析:事务、质量问题、数据图、架构。 |
Objects Tools | 对象元素探索:定位对象、引用、调用者/被调用者。 |
工具
Portfolio
- 应用 --列出CAST Imaging中可用的应用程序
- 应用程序_交易 --通过过滤支持从所有应用程序获取交易
- 应用程序_数据图 --来自所有应用程序的数据实体交互网络(数据图)
- 应用程序依赖关系 --所有应用程序之间的相互依赖关系
- 应用_质量_景点 --质量洞察,包括CVE、云检测模式和绿色检测模式
Applications
- 应用程序_数据库_探索者 --探索应用程序中的数据库表和列
- 统计 --获取应用程序的基本统计信息
- 建筑图形 --获取特定级别(层、组件、子组件、技术类别、元素类型)的架构图数据(节点/链接)
- 建筑学图形焦点 --获取特定区域的集中架构图数据
- 质量_景点 --获得与质量相关的见解(CVE、云模式、绿色模式、结构缺陷、ISO-5055)
- 质量_观察_发生 --按ID获取质量洞察的具体事件
- 包裹 --获取包信息和依赖关系
- package_交互 --按组件和版本获取与特定软件包的交互
- 交易 --通过按名称、全名或类型进行可选筛选来获取交易
- 交易_对象_有_景点 --在特定交易中获取具有洞察力的对象
- 事务_复杂对象 --在特定事务中获取复杂对象
- 交易_文件 --获取特定交易的文档
- add_transaction_document --为特定交易添加文档
- 事务图 --获取不同粒度级别的事务图数据(节点/链接)
- 事务_图形_焦点 --获取专注于复杂对象的事务图数据
- 数据图 --通过可选过滤获取数据实体交互网络(数据图)
- 数据_图形_对象_带_视线 --在特定数据图中获取具有洞察力的对象
- 数据图形复杂对象 --在特定数据图中获取复杂对象
- 数据图表文档 --获取特定数据图的文档
- add_datagraph_document --为特定数据图添加文档
- 数据图表 --获取不同粒度级别的数据图结构(节点/链接)
- 数据图表焦点 --获得专注于复杂对象的数据图结构
- 文件 --查找与搜索文本匹配的代码元素和图形的文档(要求IMAGING_code=True)
- 应用程序间的依赖关系 --获取内外应用程序间的依赖关系
- 相互依赖 --获取两个特定应用程序之间的详细依赖关系
Objects
- 物体 --获取应用程序中符合标识条件(名称、全名、修改、类型、文件路径)的对象
- object_details --获取对象的全面详细信息,包括属性、关系、代码片段和使用统计信息
- add_object_document --将文档文本添加到由ID标识的特定对象中
- 源文件 --查找定义与文件路径条件匹配的代码对象的源文件
- 源文件_详细信息 --获取有关源文件及其代码元素(库存、内部、内部、外部、测试)的详细信息
- 事务处理对象 --获取使用符合指定条件的对象的事务
- 数据图形涉及对象 --获取涉及特定对象的数据实体交互网络(数据图)
______________________________________________________________________
故障排除
| 症状 | 可能原因 | 怎么办 |
|---|---|---|
ECONNREFUSED 来自客户端 | 服务器未运行 | docker ps那么 ./run.sh 开始 |
| Auth errors | Imaging API密钥错误/过期 | 从Imaging配置文件重新生成密钥 |
| 空答案 | 无法访问成像API | 重新检查 HOST_CONTROL_PANEL / PORT_CONTROL_PANEL,健康终点 |
| HTTPS握手/错误 | 证书文件错误/丢失 | 放置 certificate.pem & private_key.pem 在...之下 certificates/,正确的perms |
| VS代码未提示输入密钥 | 缺失 inputs 在 mcp.json | 添加 inputs 块(请参阅设置) |
日志和检查
# Server logs
docker logs
# Re‑verify Imaging‑APIs
curl -H "x-api-key: " http://{CONTROL_PANEL_HOST}:8090/imaging/apis/rest/ready______________________________________________________________________
安全说明
- HTTPS在生产中:通过Nginx启用TLS终止(请参阅 跑步).
IMAGING_CODE=默认为假:启用允许MCP客户端访问源代码→ 受策略、网络和凭据限制。- 最小权限原则:限制谁可以在MCP主机中获取/输入Imaging API密钥。
______________________________________________________________________
包装内容
com.castsoftware.imaging.mcpserver.docker.1.0.2-funcrel/
├─ config/app.config
├─ nginx/nginx.conf
├─ docker-compose.yml
├─ docker-compose.https.yml
├─ run.sh
├─ .env # hidden
├─ README.md # original docs
└─ copilot-instructions.md # optional, copy to .github/______________________________________________________________________
支持
- 检查容器日志和Imaging‑API运行状况端点
- 验证
app.config,.env,mcp.json路径和值 - 确保客户端之间的网络可达性↔ 服务器↔ 成像API
许可证
此存储库仅包含文档。\ 该项目的源代码是 专有的 并且是 不 根据开源许可证发布。
- 源代码根据 商业许可证 并且不包括在此存储库中。
- 通过此存储库不会授予源代码任何权限。
- 您可以自由查看和共享此文档,但不得将其用于推断或暗示对专有软件的权利。
如需商业许可咨询,请联系您当地的CAST代表(https://www.castsoftware.com/overview).
______________________________________________________________________
