Office MCP Server

🚀 Office MCP Server

The Office MCP Server is an unofficial Java-based Model Context Protocol (MCP) Server designed to manage and process requests for Word, Excel, and other files from AI agents.

🚀 Quick Start

Framework

This project is built using Quarkus, a Kubernetes-native Java framework designed specifically for building lightweight, high-performance microservices. Quarkus offers fast startup times and low memory usage, making it ideal for cloud-native applications.

✨ Features

Supported MCP Tools and Resources

Excel Features

• Tool: Get Filename: Retrieve the filename of an Excel file.
  • Parameter: filename - The name of the Excel file.
• Tool: Create Excel Workbook: Create a new Excel workbook.
  • Parameter: filepath - The path to create the new Excel workbook.
• Tool: Create Excel Worksheet: Create a new worksheet in an Excel workbook.
  • Parameters:
    • filepath - The path to the Excel workbook.
    • sheetName - The name of the new worksheet.
• Tool: Add Excel Row: Add a row to an Excel worksheet.
  • Parameters:
    • filepath - The path to the Excel file.
    • sheetName - The name of the worksheet.
    • rowData - The data for the new row.
• Tool: Read Excel Cell: Read the content of a cell from an Excel worksheet.
  • Parameters:
    • filepath - The path to the Excel file.
    • sheetName - The name of the worksheet.
    • rowNum - The row number (0-based).
    • colNum - The column number (0-based).
• Tool: Close Excel Workbook: Close an Excel workbook.
  • Parameter: filepath - The path to the Excel file to close.
• Tool: Get Excel Worksheet Count: Get the number of worksheets in an Excel workbook.
  • Parameter: filepath - The path to the Excel file.
• Tool: Get Excel Row Count: Get the number of rows in a worksheet.
  • Parameters:
    • filepath - The path to the Excel file.
    • sheetName - The name of the worksheet.
• Tool: Get Excel Column Count: Get the number of columns in a worksheet.
  • Parameters:
    • filepath - The path to the Excel file.
    • sheetName - The name of the worksheet.

Word Features

(Note: The original text did not mention Word features, so this section is left blank.)

📦 Installation

Install via Maven

Add the following dependency to your pom.xml file:

<dependency>
    <groupId>com.example</groupId>
    <artifactId>office-mcp-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

Then run the Maven install command:

./mvnw clean install

Install via Gradle

Add the following dependency to your build.gradle file:

dependencies {
    implementation 'com.example:office-mcp-server:0.0.1-SNAPSHOT'
}

Then run the Gradle install command:

./gradlew clean build

💻 Usage Examples

How to Debug and Run

1. Download the Project: Clone or download the source code of the Office MCP Server project.
2. Build the Project: Use tools like Maven or Gradle to build the project and generate an executable JAR file.
3. Run the Server:
   • Open a terminal and navigate to the project directory.
   • Run the following command to start the server:

     java -jar target/office-mcp-server-0.0.1-SNAPSHOT-runner.jar
     

4. Access the API: Open a browser or use a tool like Postman to access the API endpoints provided by the server.

By default, the server runs at http://localhost:8080. For more detailed information, please refer to the documentation.

📚 Documentation

Configuration

Environment Variables

You can customize the server's behavior through the following environment variables:

Log Files

By default, log files are saved in the logs/ directory. You can modify the log output path or format as needed.

Testing

Unit Tests

• Run unit tests using Maven or Gradle:

  ./mvnw test
  

Integration Tests

• Run the integration test script in the project root directory:

  sh tests/run_integration_tests.sh
  

📄 License

This project is released under the MIT License. For more details, please refer to the LICENSE file.

Support

This project is provided as-is without any warranties. If you encounter any issues or have questions, please open an issue in the GitHub repository.