Skip to content

Commit dc16a06

Browse files
committed
update README.md
1 parent c14c273 commit dc16a06

File tree

1 file changed

+58
-14
lines changed

1 file changed

+58
-14
lines changed

README.md

Lines changed: 58 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,44 @@
22

33
MCP Server for the Nature Remo API.
44

5-
## WIP
5+
## Overview
66

7-
It is the MCP server for nature remo.
7+
This is an MCP server for Nature Remo, designed to handle requests and interact with the Nature Remo API using the Model Context Protocol SDK. It provides tools to manage and automate interactions with Nature Remo devices.
88

9-
- Use the Model Context Protocol SDK https://github.com/modelcontextprotocol/typescript-sdk
10-
- Refer to the sample code https://github.com/modelcontextprotocol/servers/tree/main/src/github
11-
- API spec is https://swagger.nature.global/
9+
## Prerequisites
1210

13-
TODO:
14-
15-
- Create a new TypeScript project and set up the necessary dependencies in the package.json file.
16-
- Write the MCP server code to handle requests and interact with the Nature Remo API using the SDK.
11+
1. Create your own access_token on [Nature Remo Home](https://home.nature.global/). more detail, see [documentation](https://developer.nature.global/en/)).
1712

1813
## Setup
1914

20-
### Access Token
21-
To to https://home.nature.global/ .
15+
### Usage with VS Code
2216

23-
### Usage with Claude Desktop
24-
To use this with Claude Desktop, add the following to your `claude_desktop_config.json`:
17+
Add the following configuration to your User Settings (JSON) file. Open the settings by pressing `Cmd + Shift + P` and selecting `Preferences: Open User Settings (JSON)`.
18+
19+
Alternatively, you can create a `.vscode/mcp.json` file in your workspace to share the configuration with others. Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.
2520

26-
### NPX
21+
> Note that the `mcp` key is not needed in the `.vscode/mcp.json` file.
22+
23+
```json
24+
{
25+
"mcp": {
26+
"servers": {
27+
"nature-remo": {
28+
"command": "npx",
29+
"args": [
30+
"-y",
31+
"noboru-i/nature-remo-mcp-server"
32+
],
33+
"env": {
34+
"ACCESS_TOKEN": "<YOUR_TOKEN>"
35+
}
36+
}
37+
}
38+
}
39+
}
40+
```
41+
42+
### Usage with Claude Desktop
2743

2844
```json
2945
{
@@ -41,3 +57,31 @@ To use this with Claude Desktop, add the following to your `claude_desktop_confi
4157
}
4258
}
4359
```
60+
61+
## Tools
62+
63+
This server provides the following tools:
64+
65+
- **list_devices** - List devices on the home.
66+
- No parameters required
67+
68+
- **list_appliances** - List appliances on the home.
69+
- No parameters required
70+
71+
- **operate_tv** - Operate a TV appliance.
72+
- `applianceId`: Appliance id (string, required)
73+
- `button`: Button label (string, required)
74+
75+
- **operate_aircon** - Operate an aircon appliance.
76+
- `applianceId`: Appliance id (string, required)
77+
- `airDirection`: Air direction (string, optional)
78+
- `airDirectionH`: Horizontal air direction (string, optional)
79+
- `airVolume`: Air volume (string, optional)
80+
- `button`: Button label (string, optional)
81+
- `operationMode`: Operation mode (string, optional)
82+
- `temperature`: Temperature (string, optional)
83+
- `temperatureUnit`: Temperature unit (string, optional)
84+
85+
## License
86+
87+
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.

0 commit comments

Comments
 (0)