awesome-monash-tools 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,6 +6,7 @@
6
6
 
7
7
  [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
8
8
  [![CI](https://github.com/jackdsjk/awesome-monash-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/jackdsjk/awesome-monash-tools/actions/workflows/ci.yml)
9
+ [![npm](https://img.shields.io/npm/v/awesome-monash-tools.svg)](https://www.npmjs.com/package/awesome-monash-tools)
9
10
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
10
11
  [![MCP](https://img.shields.io/badge/MCP-stdio-6B4FBB)](https://modelcontextprotocol.io)
11
12
  [![Tools](https://img.shields.io/badge/tools-22-blue)](#-tool-catalogue)
@@ -107,36 +108,36 @@ Because everything is scoped to **your own account**, the answers are yours: you
107
108
  Requires **Node.js 20.11+** and **Google Chrome** (only for the two SSO logins).
108
109
 
109
110
  ```bash
110
- # Until the npm release lands, install from source (30 seconds):
111
- git clone https://github.com/jackdsjk/awesome-monash-tools.git
112
- cd awesome-monash-tools
113
- npm install
114
- npm run build
115
- npm link # exposes the `awesome-monash` command
111
+ # Nothing to install: npx pulls the published package.
112
+ npx -y awesome-monash-tools@latest login ed
113
+ npx -y awesome-monash-tools@latest login moodle
114
+ npx -y awesome-monash-tools@latest login ontrack
115
+ npx -y awesome-monash-tools@latest login gmail --client-id <id> --client-secret <secret>
116
+
117
+ npx -y awesome-monash-tools@latest status
118
+ npx -y awesome-monash-tools@latest serve all
119
+ ```
116
120
 
117
- # Connect the sources you actually use.
118
- awesome-monash login ed
119
- awesome-monash login moodle
120
- awesome-monash login ontrack
121
- awesome-monash login gmail --client-id <id> --client-secret <secret>
121
+ Prefer a short command? Install it once and drop the `npx ...` prefix:
122
122
 
123
- # See what is connected.
124
- awesome-monash status
123
+ ```bash
124
+ npm install -g awesome-monash-tools
125
125
 
126
- # Start a server.
126
+ awesome-monash login ed
127
+ awesome-monash status
127
128
  awesome-monash serve all
128
129
  ```
129
130
 
130
131
  `login moodle` and `login ontrack` open a Chrome window: finish the normal Monash SSO login, wait for the dashboard, and the session is saved automatically. Nothing is typed into this tool.
131
132
 
132
- > After the npm release: `npx -y awesome-monash-tools@latest <command>` works identically.
133
+ > Working on the code instead? `git clone` the repo, then `npm install && npm run build && npm link`.
133
134
 
134
135
  ## 🔌 MCP configuration
135
136
 
136
137
  **Claude Code**
137
138
 
138
139
  ```bash
139
- claude mcp add monash -- awesome-monash serve all
140
+ claude mcp add monash -- npx -y awesome-monash-tools@latest serve all
140
141
  ```
141
142
 
142
143
  **Claude Desktop** (`~/Library/Application Support/Claude/claude_desktop_config.json`)
@@ -145,8 +146,8 @@ claude mcp add monash -- awesome-monash serve all
145
146
  {
146
147
  "mcpServers": {
147
148
  "monash": {
148
- "command": "awesome-monash",
149
- "args": ["serve", "all"]
149
+ "command": "npx",
150
+ "args": ["-y", "awesome-monash-tools@latest", "serve", "all"]
150
151
  }
151
152
  }
152
153
  }
@@ -157,10 +158,10 @@ Prefer one server per source (smaller tool list, clearer permissions):
157
158
  ```json
158
159
  {
159
160
  "mcpServers": {
160
- "ed": { "command": "awesome-monash", "args": ["serve", "ed"] },
161
- "moodle": { "command": "awesome-monash", "args": ["serve", "moodle"] },
162
- "gmail": { "command": "awesome-monash", "args": ["serve", "gmail"] },
163
- "ontrack": { "command": "awesome-monash", "args": ["serve", "ontrack"] }
161
+ "ed": { "command": "npx", "args": ["-y", "awesome-monash-tools@latest", "serve", "ed"] },
162
+ "moodle": { "command": "npx", "args": ["-y", "awesome-monash-tools@latest", "serve", "moodle"] },
163
+ "gmail": { "command": "npx", "args": ["-y", "awesome-monash-tools@latest", "serve", "gmail"] },
164
+ "ontrack": { "command": "npx", "args": ["-y", "awesome-monash-tools@latest", "serve", "ontrack"] }
164
165
  }
165
166
  }
166
167
  ```
@@ -171,8 +172,8 @@ Prefer one server per source (smaller tool list, clearer permissions):
171
172
 
172
173
  ```toml
173
174
  [mcp_servers.monash]
174
- command = "awesome-monash"
175
- args = ["serve", "all"]
175
+ command = "npx"
176
+ args = ["-y", "awesome-monash-tools@latest", "serve", "all"]
176
177
  ```
177
178
 
178
179
  ## 🧰 Tool catalogue
package/README.zh-CN.md CHANGED
@@ -6,6 +6,7 @@
6
6
 
7
7
  [![Awesome](https://awesome.re/badge.svg)](https://awesome.re)
8
8
  [![CI](https://github.com/jackdsjk/awesome-monash-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/jackdsjk/awesome-monash-tools/actions/workflows/ci.yml)
9
+ [![npm](https://img.shields.io/npm/v/awesome-monash-tools.svg)](https://www.npmjs.com/package/awesome-monash-tools)
9
10
  [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
10
11
  [![MCP](https://img.shields.io/badge/MCP-stdio-6B4FBB)](https://modelcontextprotocol.io)
11
12
  [![Tools](https://img.shields.io/badge/tools-22-blue)](#-工具目录)
@@ -107,36 +108,36 @@
107
108
  需要 **Node.js 20.11+** 和 **Google Chrome**(只有两个 SSO 登录会用到)。
108
109
 
109
110
  ```bash
110
- # npm 版本发布前,先从源码安装(30 秒):
111
- git clone https://github.com/jackdsjk/awesome-monash-tools.git
112
- cd awesome-monash-tools
113
- npm install
114
- npm run build
115
- npm link # 提供 `awesome-monash` 命令
111
+ # 不用安装:npx 直接从 npm 拉取
112
+ npx -y awesome-monash-tools@latest login ed
113
+ npx -y awesome-monash-tools@latest login moodle
114
+ npx -y awesome-monash-tools@latest login ontrack
115
+ npx -y awesome-monash-tools@latest login gmail --client-id <id> --client-secret <secret>
116
+
117
+ npx -y awesome-monash-tools@latest status
118
+ npx -y awesome-monash-tools@latest serve all
119
+ ```
116
120
 
117
- # 连接你实际在用的来源
118
- awesome-monash login ed
119
- awesome-monash login moodle
120
- awesome-monash login ontrack
121
- awesome-monash login gmail --client-id <id> --client-secret <secret>
121
+ 嫌命令长?装一次,之后就能用短命令:
122
122
 
123
- # 查看连接状态
124
- awesome-monash status
123
+ ```bash
124
+ npm install -g awesome-monash-tools
125
125
 
126
- # 启动 server
126
+ awesome-monash login ed
127
+ awesome-monash status
127
128
  awesome-monash serve all
128
129
  ```
129
130
 
130
131
  `login moodle` / `login ontrack` 会打开 Chrome 窗口:正常完成 Monash SSO 登录、等仪表盘加载出来,会话就自动保存了。**这个工具不会让你输入密码。**
131
132
 
132
- > npm 版本发布后,`npx -y awesome-monash-tools@latest <command>` 等价可用。
133
+ > 想改代码?`git clone` 仓库后 `npm install && npm run build && npm link`。
133
134
 
134
135
  ## 🔌 MCP 配置
135
136
 
136
137
  **Claude Code**
137
138
 
138
139
  ```bash
139
- claude mcp add monash -- awesome-monash serve all
140
+ claude mcp add monash -- npx -y awesome-monash-tools@latest serve all
140
141
  ```
141
142
 
142
143
  **Claude Desktop**(`~/Library/Application Support/Claude/claude_desktop_config.json`)
@@ -145,8 +146,8 @@ claude mcp add monash -- awesome-monash serve all
145
146
  {
146
147
  "mcpServers": {
147
148
  "monash": {
148
- "command": "awesome-monash",
149
- "args": ["serve", "all"]
149
+ "command": "npx",
150
+ "args": ["-y", "awesome-monash-tools@latest", "serve", "all"]
150
151
  }
151
152
  }
152
153
  }
@@ -157,10 +158,10 @@ claude mcp add monash -- awesome-monash serve all
157
158
  ```json
158
159
  {
159
160
  "mcpServers": {
160
- "ed": { "command": "awesome-monash", "args": ["serve", "ed"] },
161
- "moodle": { "command": "awesome-monash", "args": ["serve", "moodle"] },
162
- "gmail": { "command": "awesome-monash", "args": ["serve", "gmail"] },
163
- "ontrack": { "command": "awesome-monash", "args": ["serve", "ontrack"] }
161
+ "ed": { "command": "npx", "args": ["-y", "awesome-monash-tools@latest", "serve", "ed"] },
162
+ "moodle": { "command": "npx", "args": ["-y", "awesome-monash-tools@latest", "serve", "moodle"] },
163
+ "gmail": { "command": "npx", "args": ["-y", "awesome-monash-tools@latest", "serve", "gmail"] },
164
+ "ontrack": { "command": "npx", "args": ["-y", "awesome-monash-tools@latest", "serve", "ontrack"] }
164
165
  }
165
166
  }
166
167
  ```
@@ -171,8 +172,8 @@ claude mcp add monash -- awesome-monash serve all
171
172
 
172
173
  ```toml
173
174
  [mcp_servers.monash]
174
- command = "awesome-monash"
175
- args = ["serve", "all"]
175
+ command = "npx"
176
+ args = ["-y", "awesome-monash-tools@latest", "serve", "all"]
176
177
  ```
177
178
 
178
179
  ## 🧰 工具目录
package/llms.txt CHANGED
@@ -25,24 +25,21 @@ AI agents answering questions about a Monash student's own account: deadlines, E
25
25
  ## Install
26
26
 
27
27
  ```bash
28
- git clone https://github.com/jackdsjk/awesome-monash-tools.git
29
- cd awesome-monash-tools
30
- npm install
31
- npm run build
32
- npm link
33
- awesome-monash login ed
34
- awesome-monash status
28
+ npx -y awesome-monash-tools@latest status
29
+ npx -y awesome-monash-tools@latest login ed
35
30
  ```
36
31
 
32
+ Or install once: `npm install -g awesome-monash-tools`.
33
+
37
34
  ## MCP entry points
38
35
 
39
36
  | Server | Command |
40
37
  |---|---|
41
- | All sources | `awesome-monash serve all` |
42
- | Ed | `awesome-monash serve ed` |
43
- | Moodle | `awesome-monash serve moodle` |
44
- | Gmail | `awesome-monash serve gmail` |
45
- | OnTrack | `awesome-monash serve ontrack` |
38
+ | All sources | `npx -y awesome-monash-tools@latest serve all` |
39
+ | Ed | `npx -y awesome-monash-tools@latest serve ed` |
40
+ | Moodle | `npx -y awesome-monash-tools@latest serve moodle` |
41
+ | Gmail | `npx -y awesome-monash-tools@latest serve gmail` |
42
+ | OnTrack | `npx -y awesome-monash-tools@latest serve ontrack` |
46
43
 
47
44
  ## Constraints
48
45
 
package/package.json CHANGED
@@ -1,6 +1,5 @@
1
1
  {
2
2
  "name": "awesome-monash-tools",
3
- "version": "0.1.0",
4
3
  "description": "Agent-native MCP servers for Monash University: Ed, Moodle, Gmail and OnTrack as 22 read-only tools.",
5
4
  "license": "MIT",
6
5
  "type": "module",
@@ -8,6 +7,7 @@
8
7
  "node": ">=20.11"
9
8
  },
10
9
  "bin": {
10
+ "awesome-monash-tools": "dist/cli.js",
11
11
  "awesome-monash": "dist/cli.js",
12
12
  "awesome-monash-ed": "dist/ed/server.js",
13
13
  "awesome-monash-moodle": "dist/moodle/server.js",
@@ -53,5 +53,6 @@
53
53
  "tsx": "^4.23.15",
54
54
  "typescript": "^7.0.2",
55
55
  "vitest": "^5.0.5"
56
- }
56
+ },
57
+ "version": "0.1.1"
57
58
  }