Skip to content

Commit f939cf2

Browse files
authored
feat: setup package for publishing and guide (#3)
* build: change package name and add missing dep * fix: make build entry executable * refactor: format docs and prompts * fix: improve tool calling results consistency * chore: edit readme
1 parent 8aac671 commit f939cf2

File tree

11 files changed

+721
-101
lines changed

11 files changed

+721
-101
lines changed

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @hyperweb/agentic-tools
1+
# @hyperweb/mcp-server
22

33
This project implements a Model Context Protocol (MCP) server that helps you use Hyperweb platform tools better and easier with AI agents.
44

@@ -7,31 +7,37 @@ This project implements a Model Context Protocol (MCP) server that helps you use
77
To run the Hyperweb MCP server using npx, use the following command:
88

99
```bash
10-
npx -y @shopify/dev-mcp@latest
10+
npx -y @hyperweb/mcp-server@latest
1111
```
1212

13-
## 🛠️ Installation
13+
## Usage with Cursor or Claude Desktop
1414

15-
1. Clone the repository:
15+
Add the following configuration. For more information, read the [Cursor MCP documentation](https://docs.cursor.com/context/model-context-protocol) or the [Claude Desktop MCP guide](https://modelcontextprotocol.io/quickstart/user).
1616

17-
```bash
18-
git clone https://github.com/yourusername/agentic-tools.git
19-
cd agentic-tools
17+
```json
18+
{
19+
"mcpServers": {
20+
"hyperweb-mcp-server": {
21+
"command": "npx",
22+
"args": ["-y", "@hyperweb/mcp-server@latest"]
23+
}
24+
}
25+
}
2026
```
2127

22-
1. Install dependencies:
23-
```bash
24-
pnpm install
28+
On Windows, you might need to use this alternative configuration:
29+
30+
```json
31+
{
32+
"mcpServers": {
33+
"hyperweb-mcp-server": {
34+
"command": "cmd",
35+
"args": ["/k", "npx", "-y", "@hyperweb/mcp-server@latest"]
36+
}
37+
}
38+
}
2539
```
2640

27-
1. Set up environment variables:
28-
```bash
29-
cp .env.example .env
30-
```
31-
Edit the `.env` file with your configuration values.
32-
33-
## 🔧 Development
34-
3541
### Available Scripts
3642

3743
- `pnpm build` - Build the project and copy prompts to build directory
@@ -47,8 +53,9 @@ The server provides the following tools:
4753

4854
| Tool Name | Description |
4955
|-----------|-------------|
50-
| starship-config-gen | Generate Starship configuration |
51-
| starship-setup | Setup Starship environment |
56+
| generateStarshipConfig | Generate Starship configuration |
57+
| verifyStarshipConfig | Verify a Starship configuration |
58+
| setupStarship | Setup Starship environment |
5259

5360
### Development Tools
5461

@@ -59,7 +66,7 @@ The server provides the following tools:
5966

6067
## 📦 Project Structure
6168

62-
```
69+
```md
6370
agentic-tools/
6471
├── src/ # Source code
6572
│ └── starship/ # Starship-related tools and prompts

package.json

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"name": "@hyperweb/agentic-tools",
2+
"name": "@hyperweb/mcp-server",
33
"version": "0.0.1",
4-
"description": "",
5-
"main": "index.js",
4+
"description": "Model Context Protocol Hyperweb products",
5+
"main": "build/index.js",
66
"scripts": {
77
"build": "tsc && npm run copy-prompts && chmod 755 build/index.js",
8-
"copy-prompts": "cp -r src/starship/prompts build/starship/prompts/",
8+
"copy-prompts": "mkdir -p build/starship && cp -r src/starship/prompts build/starship/",
99
"clean": "rimraf build",
1010
"test": "vitest",
1111
"test:watch": "vitest --watch",
@@ -19,7 +19,7 @@
1919
"license": "ISC",
2020
"type": "module",
2121
"bin": {
22-
"hyperweb-mcp": "./build/index.js"
22+
"@hyperweb/mcp-server": "./build/index.js"
2323
},
2424
"devDependencies": {
2525
"@biomejs/biome": "1.9.4",
@@ -42,6 +42,7 @@
4242
"dependencies": {
4343
"@modelcontextprotocol/sdk": "^1.7.0",
4444
"dotenv": "^16.4.7",
45+
"js-yaml": "^4.1.0",
4546
"zod": "^3.24.2"
4647
}
4748
}

pnpm-lock.yaml

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
#!/usr/bin/env node
2+
13
import { readFileSync } from "node:fs";
24
import { dirname, resolve } from "node:path";
35
import { fileURLToPath } from "node:url";
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)