article
README
🚀 Upstage文档处理服务器(MCP Server)
Upstage文档处理服务器(MCP Server)是一款用于解析和提取文档信息的工具。它支持多种文件格式,能依据预定义或自动生成的模式抽取信息,助力AI模型更高效地处理和理解文档内容。
🚀 快速开始
在使用Upstage文档处理服务器前,你需要完成以下先决条件:
- 获取有效的Upstage API密钥,访问 Upstage控制台。
- 安装Python环境,并确保已安装所有依赖项(具体要求见项目文档)。
✨ 主要特性
-
文档解析(parse_document):
- 描述:处理文档并提取内容,同时保留结构。
- 参数:
file_path- 需要解析的文档路径。 - 示例查询:请解析位于
C:\Users\username\Documents\contract.pdf的文档,并提供摘要。
-
信息提取(extract_information):
- 描述:基于预定义或自动生成的模式,从文档中抽取结构化信息。
- 参数:
file_path- 文档路径;schema_path(可选)- 包含提取模式的JSON文件;auto_generate_schema(默认为true)- 是否自动生成模式。 - 示例查询:请从
C:\Users\username\Documents\invoice.pdf中提取发票号、日期和总额。
📦 安装指南
使用uv工具
- 安装
uvx,并添加到系统路径中。 - 在终端运行以下命令启动服务器:
uvx run --app upstage-mcp-server
配置Claude Desktop
编辑 claude_desktop_config.json 文件,添加如下配置:
{
"mcp_server": {
"upstage_mcp_server": {
"executable_path": "path_to_your_uv_executable",
"args": [
"run",
"--directory",
"path_to_upstage_mcp_server_directory",
"python",
"-m",
"upstage_mcp_server.server"
],
"env": {
"UPSTAGE_API_KEY": "your_api_key_here"
}
}
}
}
💻 使用示例
基础用法
文档解析
# 假设文档路径为 C:\Users\username\Documents\contract.pdf
# 调用文档解析功能
# 这里只是示意,实际可能需要根据具体代码实现调用
# 例如在Python代码中使用相关函数
# 以下代码仅为示例,非实际可运行代码
result = parse_document('C:\Users\username\Documents\contract.pdf')
信息提取
# 假设文档路径为 C:\Users\username\Documents\invoice.pdf
# 调用信息提取功能
# 这里只是示意,实际可能需要根据具体代码实现调用
# 例如在Python代码中使用相关函数
# 以下代码仅为示例,非实际可运行代码
result = extract_information('C:\Users\username\Documents\invoice.pdf')
📚 详细文档
输出目录
服务器处理文档后,输出结果位于:
- Windows:
%APPDATA%\Claude\outputs - macOS:
~/Library/Logs/Claude/output
本地开发设置
安装依赖项
使用以下命令安装必要的Python包:
pip install upstage-mcp-server
运行服务器
在项目根目录下运行:
python -m upstage_mcp_server.server
可用工具
文档解析(parse_document)
- 描述:处理文档并提取内容,保留结构。
- 参数:
file_path- 需要解析的文档路径。
信息提取(extract_information)
- 描述:根据模式从文档中抽取结构化信息。
- 参数:
file_path、schema_path(可选)、auto_generate_schema。
故障排除
常见问题
- API密钥缺失:
- 确保在
claude_desktop_config.json中正确设置了UPSTAGE_API_KEY。
- 确保在
- 文件未找到:
- 检查文件路径的绝对性,并确保没有特殊字符未被正确转义。
- 服务器启动失败:
- 确认虚拟环境已激活,所有依赖项已安装。检查Claude Desktop日志文件。
日志文件
- Windows:
%APPDATA%\Claude\logs - macOS:
~/Library/Logs/Claude
贡献指南
欢迎社区贡献!请参考项目文档的贡献指南,了解如何参与开发和提交代码。
📄 许可证
该软件遵循MIT License协议。
扫码联系在线客服