[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Workflow Status](https://github.com/ecator/cs-office-mcp-server/actions/workflows/build.yml/badge.svg)](https://github.com/ecator/cs-office-mcp-server/releases)

[🇨🇳中文](https://www.readme-i18n.com/zh/ecator/cs-office-mcp-server)
[🇯🇵日本語](https://www.readme-i18n.com/ja/ecator/cs-office-mcp-server)
[🇰🇷한국어](https://www.readme-i18n.com/ko/ecator/cs-office-mcp-server)
[🇩🇪Deutsch](https://www.readme-i18n.com/de/ecator/cs-office-mcp-server) 
[🇪🇸Español](https://www.readme-i18n.com/es/ecator/cs-office-mcp-server)
[🇫🇷français](https://www.readme-i18n.com/fr/ecator/cs-office-mcp-server)
[🇵🇹Português](https://www.readme-i18n.com/pt/ecator/cs-office-mcp-server)
[🇷🇺Русский](https://www.readme-i18n.com/ru/ecator/cs-office-mcp-server)

# Overview

The MCP Server for operating Office files such as Excel, Word, PowerPoint, Outlook, and PDF.

You must install Office 2016 and later versions to use this MCP server.

# Use

[Download the latest version](https://github.com/ecator/cs-office-mcp-server/releases) and extract it to any location.

Then add the following configuration to the MCP servers configuration.

```json
{
  "mcpServers": {
    "office": {
      "command": "DRIVER:\\PATH\\TO\\cs-office-mcp-server.exe",
      "args": [],
      "env": {}
    }
  }
}
```

Please refer to the following if you are using [Codex](https://github.com/openai/codex/blob/main/docs/config.md#mcp-integration).

> `%USERPROFILE%\.codex\config.toml`

```toml
[mcp_servers.office]
command = 'cmd'
args = [
    "/c",
    'DRIVER:\PATH\TO\cs-office-mcp-server.exe',
]
env = { SystemRoot = 'C:\Windows' }
startup_timeout_sec = 300
tool_timeout_sec = 300
enabled = true
```

Note that this is only supported on Windows with Office 2016 (64-bit version) or above installed!

# Tools
## Excel

### `excel_run_macro`
Run a macro of the specified Excel file.
#### parameters
- `fullName*`: The full path of the Excel file.
- `macroName*`: The name of macro.
- `macroParameters`: The parameters of macro. The maximum number is 30.
- `save`: Save the file after executing the macro.
- `password`: The password of the Excel file, if there is one.

### `excel_read_used_range`
Read the value of used range of cells from the specified worksheet. If a cell is empty, it will not be included in the returned result set.
#### parameters
- `fullName*`: The full path of the Excel file.
- `sheetName*`: The sheet name of the Excel file.
- `password`: The password of the Excel file, if there is one.

### `excel_get_sheets`
Get all the sheet names of the specified Excel file.
#### parameters
- `fullName*`: The full path of the Excel file.
- `password`: The password of the Excel file, if there is one.

### `excel_write`
Write data into a cell or a range of cells of the specified worksheet to an Excel file.
#### parameters
- `fullName*`: The full path of the Excel file. It will be created if not exist.
- `sheetName`: The sheet name of the Excel file. It will be created if not exist.
- `data`: The data that needs to be written in.
- `startColumn`: The first column as a letter where the data is written.(such as A)
- `startRow`: The first row number where the data is written.
- `password`: The password of the Excel file, if there is one.
- `forceOverwriteFile`: Force overwrite to create a new one when the file exists.
- `forceOverwriteSheet`: Force overwrite to create a new one when the sheet exists.

### `excel_rename_sheet`
Change the name of the sheet of the specified Excel file.
#### parameters
- `fullName*`: The full path of the Excel file.
- `oldSheetName*`: The old sheet name of the Excel file.
- `newSheetName*`: The new sheet name of the Excel file.
- `password`: The password of the Excel file, if there is one.

### `excel_copy_sheet`
Copy the sheet of the specified Excel file.
#### parameters
- `fullName*`: The full path of the Excel file.
- `sourceSheetName*`: The source sheet name of the Excel file.
- `targetSheetName*`: The target sheet name of the Excel file.
- `deleteTargetIfExists`: If the target sheet exists, delete it first.
- `beforeSourceSheet`: Move target sheet to the left of source sheet after copying, otherwise the right of source sheet.
- `password`: The password of the Excel file, if there is one.

### `excel_get_tables`
Get all the table names of the specified Excel file.
#### parameters
- `fullName*`: The full path of the Excel file.
- `password`: The password of the Excel file, if there is one.

### `excel_delete_sheet`
Delete the sheet of the specified Excel file.
#### parameters
- `fullName*`: The full path of the Excel file.
- `sheetName*`: The sheet name of the Excel file.
- `password`: The password of the Excel file, if there is one.

### `excel_get_table_content`
Get the content of a table of the specified Excel file.
#### parameters
- `fullName*`: The full path of the Excel file.
- `tableName*`: The table name of the Excel file.
- `password`: The password of the Excel file, if there is one.

### `excel_find`
Find value from Excel files.
#### parameters
- `fullNameList*`: The list of full path of Excel files that need to be searched for.
- `searchValue*`: The value to be searched for which can use wildcard characters like `?`(any single character), `*`(any number of characters), `~` followed by `?`, `*`, or `~`(a question mark, asterisk, or tilde).
- `matchPart`: Match against any part of the search text when true. Match against the whole of the search text when false.
- `ignoreCase`: Ignoring lower case and upper case differences when true. Case insensitive when false
- `password`: The password of the Excel files, if there is one and all are the same.

### `excel_read`
Read the value of a cell or a range of cells from the specified worksheet. If a cell is empty, it will not be included in the returned result set.
#### parameters
- `fullName*`: The full path of the Excel file.
- `sheetName*`: The sheet name of the Excel file.
- `startColumn`: The first column as a letter.(such as A)
- `startRow`: The first row number.
- `endColumn`: The last column as a letter.(such as Z) If empty, then use xlToRight relative to startColumn
- `endRow`: The last row number. If empty, then use xlDown relative to startRow
- `password`: The password of the Excel file, if there is one.

### `excel_clear`
Clear the value of a cell or a range of cells from the specified worksheet.
Clear the entire sheet if startColumn or startRow is null.
#### parameters
- `fullName*`: The full path of the Excel file.
- `sheetName*`: The sheet name of the Excel file.
- `startColumn`: The first column as a letter.(such as A)
- `startRow`: The first row number.
- `endColumn`: The last column as a letter.(such as Z) If empty, then use xlToRight relative to startColumn
- `endRow`: The last row number. If empty, then use xlDown relative to startRow
- `password`: The password of the Excel file, if there is one.


## Word

### `word_run_macro`
Run a macro of the specified Word file.
#### parameters
- `fullName*`: The full path of the Word file.
- `macroName*`: The name of macro.
- `macroParameters`: The parameters of macro. The maximum number is 30.
- `save`: Save the file after executing the macro.
- `password`: The password of the Word file, if there is one.

### `word_clear`
Clear the whole content of the specified Word file.
#### parameters
- `fullName*`: The full path of the Word file.
- `password`: The password of the Word file, if there is one.

### `word_read`
Get the text content of the specified Word file.
#### parameters
- `fullName*`: The full path of the Word file.
- `fromPage`: The starting page number to read.
- `toPage`: The end page number to read. If it's empty, then read up to the last page.
- `password`: The password of the Word file, if there is one.

### `word_write`
Write data into an Word file.
#### parameters
- `fullName*`: The full path of the Word file. It will be created if not exist.
- `data`: The data that needs to be written in.
- `insertAfter`: Append to the end of the document when true. Append to the beginning of the document when false.
- `insertNewline`: Append a newline when writing to an existing file and the newline option is true. When data is appended to the end of the document, a newline character is added before the data. When data is prepended to the beginning of the document, a newline character is added after the data.
- `password`: The password of the Word file, if there is one.
- `forceOverwriteFile`: Force overwrite to create a new one when the file exists.

### `word_find`
Find value from Word files.
#### parameters
- `fullNameList*`: The list of full path of Word files that need to be searched for.
- `searchValue*`: The value to be searched for which can use wildcard characters like `?`(any single character), `*`(any number of characters), `\` followed by `?`, `*`, or `\`(a question mark, asterisk, or backslash).
- `matchPart`: Match against any part of part of a larger word when true. Match against the entire words of the search text when false.
- `ignoreCase`: Ignoring lower case and upper case differences when true. Case insensitive when false.
- `password`: The password of the Word files, if there is one and all are the same.

### `word_get_page_count`
Get all the number of the pages of the specified Word file.
#### parameters
- `fullName*`: The full path of the Word file.
- `password`: The password of the Word file, if there is one.

### `word_replace`
Replace value from Word files.
#### parameters
- `fullNameList*`: The list of full path of Word files that need to be searched for.
- `oldValue*`: The value to be searched for which can use wildcard characters like `?`(any single character), `*`(any number of characters), `\` followed by `?`, `*`, or `\`(a question mark, asterisk, or backslash).
- `newValue*`: The new replacement value.
- `matchPart`: Match against any part of part of a larger word when true. Match against the entire words of the search text when false.
- `ignoreCase`: Ignoring lower case and upper case differences when true. Case insensitive when false.
- `replaceAll`: Replace all matching items when true. Replace only the first matching item when false.
- `password`: The password of the Word files, if there is one and all are the same.

## PowerPoint

### `powerpoint_run_macro`
Run a macro of the specified PowerPoint file.
#### parameters
- `fullName*`: The full path of the PowerPoint file.
- `macroName*`: The name of macro.
- `macroParameters`: The parameters of macro. The maximum number is 30.
- `save`: Save the file after executing the macro.
- `password`: The password of the PowerPoint file, if there is one.

### `powerpoint_read`
Get the text content of the specified PowerPoint file.
#### parameters
- `fullName*`: The full path of the PowerPoint file.
- `fromSlide`: The starting slide number to read.
- `toSlide`: The end slide number to read. If it's empty, then read up to the last slide.
- `password`: The password of the PowerPoint file, if there is one.

### `powerpoint_find`
Find value from PowerPoint files.
#### parameters
- `fullNameList*`: The list of full path of PowerPoint files that need to be searched for.
- `searchValue*`: The value to be searched for.
- `matchPart`: Match against any part of part of a larger word when true. Match against the entire words of the search text when false.
- `ignoreCase`: Ignoring lower case and upper case differences when true. Case insensitive when false.
- `password`: The password of the PowerPoint files, if there is one and all are the same.

### `powerpoint_get_slide_count`
Get all the number of the slides of the specified PowerPoint file.
#### parameters
- `fullName*`: The full path of the PowerPoint file.
- `password`: The password of the PowerPoint file, if there is one.


## Outlook

### `outlook_read_appointments`
Read the contents of the appointments in the calendar of Outlook.
#### parameters
- `withinDays`: The range of days for appointments. Read past appointments if a negative number used.

### `outlook_send_appointment`
Send a appointment using Outlook.
#### parameters
- `subject*`: The subject of the appointment.
- `participants*`: An array of email addresses representing the participants of the meeting.
- `startTime*`: The start time of the appointment.
- `duration*`: The duration of the appointment in minutes. Must be greater than 0.
- `location`: The location of the appointment.
- `body`: The body content of the appointment.
- `displayBeforeSend`: Display the appointment before sending, and send it after manual confirmation, otherwise send it directly.

### `outlook_get_inbox_mail_count`
Get all the number of mail items in the inbox of Outlook.
#### parameters
(No parameters)

### `outlook_read_inbox_mails`
Read the contents of the mails in the inbox of Outlook.
#### parameters
- `startItem`: The starting position of the item to be read, which starts from 1.
- `maxItems`: Maximum number of mails to be read.
- `newestFirst`: The sorting order of the returned mails, specifically prioritizing items that were received most recently.

### `outlook_send_mail`
Send a mail using Outlook.
#### parameters
- `subject*`: The subject of the mail.
- `sendTo*`: The primary recipient(s) of the mail.
- `body*`: The content of the mail body. Can be plain text or HTML, depending on the useHtml.
- `useHtml`: A boolean value indicating whether the mail body should be formatted as HTML.
- `sendCc`: The CC recipient(s) of the mail.
- `sendBcc`: The BCC recipient(s) of the mail.
- `displayBeforeSend`: Display the mail before sending, and send it after manual confirmation, otherwise send it directly.

### `outlook_find_inbox_mails`
Find the contents of the mails in the inbox of Outlook.
#### parameters
- `searchValue`: The value to be searched for will be searched in the subject and body. No filtering if empty.
- `senders`: Email or name of senders need to be specified. No filtering if empty.
- `maxItems`: Maximum number of mails to return.
- `newestFirst`: The sorting order of the returned mails, specifically prioritizing items that were received most recently.

## PDF

### `pdf_get_page_count`
Get all the number of the pages of the specified PDF file.
#### parameters
- `fullName*`: The full path of the PDF file.
- `password`: The password of the PDF file, if there is one.

### `pdf_read`
Get the text content of the specified PDF file.
#### parameters
- `fullName*`: The full path of the PDF file.
- `fromPage`: The starting page number to read.
- `toPage`: The end page number to read. If it's empty, then read up to the last page.
- `password`: The password of the PDF file, if there is one.

### `pdf_find`
Find value from PDF files.
#### parameters
- `fullNameList*`: The list of full path of PDF files that need to be searched for.
- `searchValue*`: The value to be searched for which can use wildcard characters like `?`(any single character), `*`(any number of characters), `\` followed by `?`, `*`, or `\`(a question mark, asterisk, or backslash).
- `matchPart`: Match against any part of part of a larger word when true. Match against the entire words of the search text when false.
- `ignoreCase`: Ignoring lower case and upper case differences when true. Case insensitive when false.
- `password`: The password of the PDF files, if there is one and all are the same.

### `pdf_merge`
Merge multiple PDF files into a single PDF file.
#### parameters
- `fullNameList*`: The list of full path of PDF files to merge.
- `outputFullName*`: The output full path of the merged PDF file.

### `pdf_extract`
Extract pages from a PDF file into a new PDF file.
#### parameters
- `fullName*`: The full path of the PDF file to extract from.
- `outputFullName*`: The output full path of the extracted PDF file.
- `fromPage*`: The starting page number to extract (1-based).
- `toPage*`: The end page number to extract (1-based).
- `password`: The password of the PDF file, if there is one.