Unstructured API MCP Server

🚀 Unstructured MCP Server Guide

This guide provides detailed instructions on installing, configuring, and running the Unstructured MCP server, along with troubleshooting tips and advanced usage information.

🚀 Quick Start

Start with Make Commands

make server           # Start the MCP server (SSE mode)
make sse-server      # Start the SSE protocol server
make sse-client      # Run the client in SSE mode
make stdio-server    # Start the Stdio protocol server

Manual Start

1. Start the MCP server (SSE mode):

   uv run python uns_mcp/server.py --host 127.0.0.1 --port 8080
   

2. Start the debugging interface:

   mcp dev uns_mcp/server.py
   

📦 Installation

Install Using a Virtual Environment

1. Create and activate a Python virtual environment:

   python -m venv ./.venv && source ./.venv/bin/activate
   

2. Install project dependencies:

   pip install -r requirements.txt
   

Quick Installation (Optional)

If you only need to run the example, you can use the following command to directly get all the necessary files:

make init

📚 Documentation

Project Structure

.
├── CHANGELOG.md                  # Version update log
├── README.md                     # User guide
├── requirements.txt             # Dependency management file
├── Makefile                      # Automated build script
├── uns_mcp/                     # Unstructured MCP server code
│   ├── server.py                # Main service entry
│   └── __init__.py              # Package initialization file
└── minimal_client/               # Minimized client code
    ├── client.py                 # Client main program
    ├── __init__.py               # Package initialization file
    └── tools/                    # Tool module
        └── uns_structured.py     # Unstructured tool interface

Configuration

Environment Variable Configuration

• LOG_LEVEL: Set the log level. Optional values are DEBUG, INFO, WARNING, ERROR, and the default is INFO.
• DEBUG_API_REQUESTS: Enable or disable the debug output of API request parameters. The default is False.

Tool Module Description

1. minimal_client/tools/uns_structured.py:
   • Provides an interface for interacting with the unstructured service, including functions such as file processing and model invocation.

Debugging Tools

Use the Anthropic MCP Checker

Run the following command to start the debugging interface:

mcp dev uns_mcp/server.py

Client Terminal Access

Use the @wonderwhy-er/desktop-commander package to add terminal access permissions:

1. Install the package:

   npx @wonderwhy-er/desktop-commander setup
   

2. Attach parameters when starting the client:

   uv run python minimal_client/client.py "http://127.0.0.1:8080" --terminal
   

Known Issues

Common Errors

• Port Conflict: If the startup fails and the port is occupied, please change the port:

  uv run python uns_mcp/server.py --host 127.0.0.1 --port 8081
  

Troubleshooting

View Logs

• View the service log:

  tail -f uns_mcp/logs/server.log
  

Appendix

Command-Line Tools

Start Command Examples

# Start the MCP server (specify the port and host)
uv run python uns_mcp/server.py --host 127.0.0.1 --port 8080

# Start in debug mode
DEBUG=1 uv run python uns_mcp/server.py --host 127.0.0.1 --port 8080

Client Usage Examples

uv run python minimal_client/client.py --help

Advanced Topics

Extended Development

• Expand more tool modules in the minimal_client/tools/ directory.

Custom Log Format

Modify the logging_config.yml file to customize the log output format:

handlers:
  file_handler:
    class: logging.FileHandler
    filename: logs/server.log
    mode: a
    formatter: customFormatter
formatters:
  customFormatter:
    format: "%(asctime)s - %(levelname)s - %(message)s"

Document History

Modification Records

• v1.0: The initial version was released, including basic functions and documentation.
• v1.1: Added support for debugging tools and optimized the logging system.

For more help, please refer to the project source code or contact the maintenance team.