Skip to content

Commit cfe8808

Browse files
committed
readme: Installation instructions for executables
1 parent e9d26c9 commit cfe8808

File tree

1 file changed

+71
-31
lines changed

1 file changed

+71
-31
lines changed

README.md

Lines changed: 71 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,34 +9,81 @@ Related links:
99
- https://openpyxl.readthedocs.io/en/stable/index.html
1010
- https://modelcontextprotocol.io/quickstart/server
1111

12-
## Setting it up
13-
14-
Clone repo into some folder, in my examples below I am using `/Users/jonas/repos/openpyxl_mcp_server`. Then:
15-
16-
```sh
17-
python -m venv venv
18-
source venv/bin/activate
19-
pip install -r requirements.txt
20-
```
12+
## Installation
13+
14+
### General Steps
15+
16+
1. Download the latest version of the executable from https://github.com/jonemo/openpyxl-mcp-server/releases. `openpyxl_mcp_server` is for MacOS, `openpyxl_mcp_server.exe` is for Windows.
17+
2. Configure your MCP Client. Most commonly this will be Claude Desktop, see instructions in next section.
18+
19+
Alternatively, if you don't trust my executables, you can also install the source version of the code directly from this repo. See the "From Source" section below.
20+
21+
### Claude Desktop
22+
23+
_Note that this only works with the [Claude Desktop app](https://claude.ai/download), not with Claude running in the web browser._
24+
25+
1. Have Claude Desktop installed.
26+
2. Have the MCP server executable downloaded (see previous section).
27+
This assumes that you have downloaded the executable to your Downloads folder.
28+
You can use any other folder, adjust the paths in the configuration below accordingly.
29+
3. In Claude Desktop, open the "Settings..." menu:
30+
![](https://mintlify.s3.us-west-1.amazonaws.com/mcp/images/quickstart-menu.png)
31+
4. Navigate to the "Developer" section of the settings.
32+
5. Click "Edit Config". This will create a config file for MCP servers if you didn't have one already.
33+
The default location of this file is:
34+
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
35+
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
36+
6. On MacOS, add the following to your `claude_desktop_config.json`.
37+
Replace `<YOUR-USERNAME>` with your MacOS username.
38+
If you already use other MCP servers, you'll have to merge the JSON into the existing contents.
39+
```json
40+
{
41+
"mcpServers": {
42+
"inspect_excel_xlsx_file": {
43+
"command": "/Users/<YOUR-USERNAME>/Downloads/openpyxl_mcp_server",
44+
"args": []
45+
}
46+
}
47+
}
48+
```
49+
7. On Windows, add the following to your `claude_desktop_config.json`.
50+
Replace `<YOUR-USERNAME>` with your MacOS username.
51+
If you already use other MCP servers, you'll have to merge the JSON into the existing contents.
52+
```json
53+
{
54+
"mcpServers": {
55+
"inspect_excel_xlsx_file": {
56+
"command": "C:\\Users\\<YOUR-USERNAME>\\Downloads\\openpyxl_mcp_server",
57+
"args": []
58+
}
59+
}
60+
}
61+
```
62+
8. After updating your configuration file, you need to restart the Claude app for the changes to take effect.
2163

22-
## Configuring Claude Desktop
64+
If you encounter problems, please consult these resources:
2365

24-
See the "Testing your server with Claude for Desktop" section of https://modelcontextprotocol.io/quickstart/server for instructions how to configure Claude Desktop. The exact command to use for this server is below.
66+
- [Anthropic's documentation for users](https://modelcontextprotocol.info/docs/quickstart/user/).
67+
- The "Testing your server with Claude for Desktop" section of [Anthropic's documentation for developers](https://modelcontextprotocol.io/quickstart/server)
68+
- Someone also made a config file generator at https://claudedesktopconfiggenerator.com/
2569

26-
## Claude Desktop configuration
70+
## Configuring Cursor to use this
2771

28-
Note that this only works with the [Claude Desktop app](https://claude.ai/download), not with Claude running in the web browser.
72+
Instructions for configuring MCP servers in Cursor are at https://docs.cursor.com/context/model-context-protocol.
2973

30-
If you have not used MCP with Claude Desktop before, you must create the `claude_desktop_config.json` configuration file.
31-
You can do this by opening the "Settings" menu and then go to the "Developer" menu item, then follow the instructions.
74+
### From Source (for development)
3275

33-
Alternatively, you can create the file yourself. The common locations of it are:
76+
This section only applies if you wish to modify the source code or if you do not trust the provided executables and prefer to run from source code.
3477

35-
- macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
36-
- Windows: %APPDATA%\Claude\claude_desktop_config.json
78+
```sh
79+
git clone [email protected]:jonemo/openpyxl-mcp-server.git
80+
cd openpyxl-mcp-server
81+
python -m venv venv
82+
source venv/bin/activate
83+
pip install -r requirements.txt
84+
```
3785

38-
Add the following to your `claude_desktop_config.json`.
39-
If you already use other MCP servers, you'll have to merge the JSON into the existing contents.
86+
Assuming you've cloned your repo to `/Users/jonas/repos/openpyxl_mcp_server`, the configuration file contents should now change to:
4087

4188
```json
4289
{
@@ -49,17 +96,6 @@ If you already use other MCP servers, you'll have to merge the JSON into the exi
4996
}
5097
```
5198

52-
After updating your configuration file, you need to restart the Claude app for the changes to take effect.
53-
54-
Note that there is a separate `config.json` file that lives in the same folder. Don't touch that one.
55-
56-
If you encounter problems, please consult [Anthropic's documentation](https://modelcontextprotocol.info/docs/quickstart/user/).
57-
Someone also made a config file generator at https://claudedesktopconfiggenerator.com/
58-
59-
## Configuring Cursor to use this
60-
61-
Instructions for setting it up in Cursor are at https://docs.cursor.com/context/model-context-protocol.
62-
6399
## Example prompts
64100

65101
### Example 1
@@ -238,3 +274,7 @@ openpyxl-mcp-server is currently listed in these MCP server directories:
238274

239275
- https://mcp.so/server/openpyxl-mcp-server/jonemo
240276
- https://mcpserver.cloud/server/openpyxl-mcp-server
277+
278+
TODO:
279+
280+
https://www.mcpserverfinder.com/

0 commit comments

Comments
 (0)