使用说明
贸易监督支持MCP服务器
MCP(模型上下文协议)服务器,旨在通过与现有的SQL配置和Java代码库集成来自动化贸易监控支持工作流程。
概述
此MCP服务器使您能够:
- 解析用户查询邮件 -自动从支持电子邮件中提取关键信息
- 搜索SQL配置文件 -查找相关的数据库查询和配置
- 搜索Java代码 -查找报告生成类和方法
- 执行Java报告 -运行Java进程以生成数据和报告
- 生成响应摘要 -为用户查询创建全面的回复
安装
先决条件
- Python 3.10或更高版本
uv包管理器(推荐)或pip
使用紫外线进行安装(推荐)
# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh
# Install the MCP server
uv pip install -e .
使用pip安装
pip install -e .
配置
使用VS代码进行设置
- 打开VS代码设置
- 搜索“MCP”
- 添加新的MCP服务器配置:
{
"mcp.servers": {
"trade-surveillance": {
"type": "stdio",
"command": "uv",
"args": [
"--directory",
"/absolute/path/to/mcp_test_2",
"run",
"trade-surveillance-mcp"
]
}
}
}
使用Claude Desktop进行设置
添加到您的 claude_desktop_config.json:
{
"mcpServers": {
"trade-surveillance": {
"command": "uv",
"args": [
"--directory",
"/absolute/path/to/mcp_test_2",
"run",
"trade-surveillance-mcp"
]
}
}
}
macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
窗户: %APPDATA%\Claude\claude_desktop_config.json
🎯 基于关键字的搜索(无文件路径!)
此MCP服务器使用 元数据注释 因此,Copilot可以通过以下方式查找文件:
SQL注释示例:
-- @keywords: trade, settlement, daily, reconciliation
-- @type: compliance_report
-- @description: Daily trade settlement reconciliation report
Java注释示例:
/**
* @keywords settlement, report, generator
* @type report_generator
* @description Generates daily settlement reports
*/
结果: 按“结算报告”等关键字而不是文件路径搜索副本!
📚 文档:
- QUICKSTART.md -5分钟后开始
- METADATA_GUIDE.md -完整的注释指南
examples/-带注释的SQL和Java示例
用法
在VS代码中使用GitHub Copilot
- 与Copilot聊天
- 粘贴用户查询电子邮件
- Copilot将自动使用MCP工具:
- 解析电子邮件
- 搜索相关配置 使用关键词 (不是文件路径!)
- 搜索Java代码 使用关键词
- 执行报告
- 生成响应
示例提示:
I received this email from a user:
[Paste email content here]
Can you help me investigate and generate the necessary reports?
可用工具
1. parse_email_inquiry
从用户查询电子邮件中提取关键信息,包括查询类型、交易ID、时间段和优先级。
2. search_sql_configs ⭐ 基于元数据的搜索
通过以下方式搜索SQL配置文件 关键词 而不是文件路径。使用元数据注释搜索文件(请参阅metadata_GUIDE.md)。
3. search_java_code ⭐ 基于元数据的搜索
通过以下方式定位Java类和方法 关键词 而不是文件路径。使用javadoc注释可以找到类(请参阅METADATA_GUIDE.md)。
4. execute_java_report
使用适当的配置文件运行Java进程以生成报告。
5. rebuild_metadata_index
通过扫描所有带注释的SQL配置和Java文件来重建搜索索引。在添加新文件或更新注释后运行此操作。
6. generate_response_summary
为用户创建全面的摘要响应。
项目结构
mcp_test_2/
├── trade_surveillance_mcp/
│ ├── __init__.py
│ └── server.py # Main MCP server implementation
├── pyproject.toml # Project dependencies
├── README.md
└── .github/
└── copilot-instructions.md
发展
本地运行
# Run the server directly
uv run trade-surveillance-mcp
# Or with Python
python -m trade_surveillance_mcp.server
定制
您需要自定义服务器以使用您的特定存储库结构:
- 更新搜索路径 -修改
config_directory和code_directory参数 - 实现电子邮件解析 -在中添加电子邮件解析逻辑
parse_email_inquiry - 添加文件搜索 -在中实现实际文件搜索
search_sql_configs和search_java_code - 配置Java执行 -在中添加Java类路径和执行逻辑
execute_java_report
连接到您的存储库
将MCP服务器指向您的实际配置和代码存储库:
# Example: Update default directories
@mcp.tool()
async def search_sql_configs(
search_term: str,
config_directory: str = "/path/to/your/sql/configs"
):
# Your implementation
后续步骤
- ✅ MCP服务器已准备就绪! -重新启动VS代码以加载它
- 📝 为文件添加注释 -将元数据关键字添加到SQL配置和Java代码中(QUICKSTART.md)
- 🔍 构建索引 -使用
rebuild_metadata_indexCopilot中的工具 - ⚙️ 自定义路径 -更新中的默认目录
server.py到你的repos - 🎯 使用Copilot进行测试 -粘贴用户电子邮件,让Copilot按关键字搜索!
关键创新:不再进行文件路径搜索! 🎉
您的SQL配置和Java文件现在 可按关键字搜索:
- Copilot通过文件的功能而不是位置来查找文件
- 搜索“结算报告”而不是记住
configs/reports/daily/settlement_v2.sql - 请参阅示例
examples/configs/和examples/src/
故障排除
服务器未出现在VS代码中
- 检查VS代码输出面板中的MCP服务器日志
- 验证配置中的绝对路径是否正确
- 确保
uv已安装并位于PATH中
Python版本问题
- 确保已安装Python 3.10+:
python --version - 使用
uv为了更好的环境管理
Java执行错误
- 验证Java是否已安装:
java -version - 检查类路径配置
- 确保配置文件可访问
资源
许可证
麻省理工学院