You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+58-14Lines changed: 58 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,28 +2,44 @@
2
2
3
3
MCP Server for the Nature Remo API.
4
4
5
-
## WIP
5
+
## Overview
6
6
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.
8
8
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
12
10
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/)).
17
12
18
13
## Setup
19
14
20
-
### Access Token
21
-
To to https://home.nature.global/ .
15
+
### Usage with VS Code
22
16
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.
25
20
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
27
43
28
44
```json
29
45
{
@@ -41,3 +57,31 @@ To use this with Claude Desktop, add the following to your `claude_desktop_confi
41
57
}
42
58
}
43
59
```
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)
0 commit comments