mirror of
https://github.com/haris-musa/excel-mcp-server.git
synced 2025-12-08 17:12:41 +08:00
Enhance README with logo and badges; update documentation; modify read_only to False (#32)
This commit is contained in:
78
README.md
78
README.md
@ -1,3 +1,11 @@
|
||||
<p align="center">
|
||||
<img src="assets/logo.svg" alt="Excel MCP Server Logo" width="300"/>
|
||||
</p>
|
||||
|
||||
[](https://pypi.org/project/excel-mcp-server/)
|
||||
[](https://pypi.org/project/excel-mcp-server/)
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
|
||||
[](https://mseep.ai/app/haris-musa-excel-mcp-server)
|
||||
|
||||
# Excel MCP Server
|
||||
@ -20,72 +28,48 @@ A Model Context Protocol (MCP) server that lets you manipulate Excel files witho
|
||||
|
||||
- Python 3.10 or higher
|
||||
|
||||
### Installation
|
||||
|
||||
1. Clone the repository:
|
||||
```bash
|
||||
git clone https://github.com/haris-musa/excel-mcp-server.git
|
||||
cd excel-mcp-server
|
||||
```
|
||||
|
||||
2. Install using uv:
|
||||
```bash
|
||||
uv pip install -e .
|
||||
```
|
||||
|
||||
### Running the Server
|
||||
|
||||
The server supports two transport modes: stdio and SSE.
|
||||
|
||||
#### Using stdio transport (default)
|
||||
#### Using stdio transport
|
||||
|
||||
Stdio transport is ideal for direct integration with tools like Cursor Desktop or local development, which can manipulate local files:
|
||||
|
||||
```bash
|
||||
excel-mcp-server stdio
|
||||
uvx excel-mcp-server stdio
|
||||
```
|
||||
|
||||
#### Using SSE transport
|
||||
|
||||
SSE transport is perfect for web-based applications and remote connections, which manipulate remote files:
|
||||
SSE transport is perfect for remote connections, which manipulate remote files:
|
||||
|
||||
```bash
|
||||
excel-mcp sse
|
||||
```
|
||||
|
||||
You can specify host and port for the SSE server:
|
||||
|
||||
```bash
|
||||
excel-mcp sse --host 127.0.0.1 --port 8080
|
||||
uvx excel-mcp-server sse
|
||||
```
|
||||
|
||||
## Using with AI Tools
|
||||
|
||||
### Cursor IDE
|
||||
|
||||
1. Add this configuration to Cursor, choosing the appropriate transport method for your needs:
|
||||
1. Add this configuration to your client, choosing the appropriate transport method for your needs:
|
||||
|
||||
**Stdio transport connection** (for local integration):
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"excel-stdio": {
|
||||
"command": "uv",
|
||||
"args": ["run", "excel-mcp-server", "stdio"]
|
||||
"command": "uvx",
|
||||
"args": ["excel-mcp-server", "stdio"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**SSE transport connection** (for web-based applications):
|
||||
**SSE transport connection**:
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"excel": {
|
||||
"url": "http://localhost:8000/sse",
|
||||
"env": {
|
||||
"EXCEL_FILES_PATH": "/path/to/excel/files"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -93,25 +77,37 @@ excel-mcp sse --host 127.0.0.1 --port 8080
|
||||
|
||||
2. The Excel tools will be available through your AI assistant.
|
||||
|
||||
### Remote Hosting & Transport Protocols
|
||||
## Environment Variables & File Path Handling
|
||||
|
||||
This server supports both stdio and SSE transport protocols for maximum flexibility:
|
||||
### SSE Transport
|
||||
|
||||
1. **Using with Claude Desktop:**
|
||||
- Use Stdio transport
|
||||
When running the server with the **SSE protocol**, you **must set the `EXCEL_FILES_PATH` environment variable on the server side**. This variable tells the server where to read and write Excel files.
|
||||
- If not set, it defaults to `./excel_files`.
|
||||
|
||||
2. **Hosting Your MCP Server (SSE):**
|
||||
- [Remote MCP Server Guide](https://developers.cloudflare.com/agents/guides/remote-mcp-server/)
|
||||
You can also set the `FASTMCP_PORT` environment variable to control the port the server listens on (default is `8000` if not set).
|
||||
- Example (Windows PowerShell):
|
||||
```powershell
|
||||
$env:EXCEL_FILES_PATH="E:\MyExcelFiles"
|
||||
$env:FASTMCP_PORT="8080"
|
||||
uvx excel-mcp-server sse
|
||||
```
|
||||
- Example (Linux/macOS):
|
||||
```bash
|
||||
EXCEL_FILES_PATH=/path/to/excel_files FASTMCP_PORT=8080 uvx excel-mcp-server sse
|
||||
```
|
||||
|
||||
## Environment Variables (for SSE transport)
|
||||
### Stdio Transport
|
||||
|
||||
- `FASTMCP_PORT`: Server port for SSE transport (default: 8000)
|
||||
- `EXCEL_FILES_PATH`: Directory for Excel files (default: `./excel_files`)
|
||||
When using the **stdio protocol**, the file path is provided with each tool call, so you do **not** need to set `EXCEL_FILES_PATH` on the server. The server will use the path sent by the client for each operation.
|
||||
|
||||
## Available Tools
|
||||
|
||||
The server provides a comprehensive set of Excel manipulation tools. See [TOOLS.md](TOOLS.md) for complete documentation of all available tools.
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://www.star-history.com/#haris-musa/excel-mcp-server&Date)
|
||||
|
||||
## License
|
||||
|
||||
MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
||||
Reference in New Issue
Block a user