Skip to content

Commit 4f0e6ae

Browse files
committed
chore: inspector
1 parent 5f0a7cf commit 4f0e6ae

File tree

2 files changed

+28
-19
lines changed

2 files changed

+28
-19
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,30 @@
1-
# Agentic Tools
1+
# @hyperweb/agentic-tools
22

3-
A collection of TypeScript-based tools for building AI-powered applications using the Model Context Protocol and Mistral AI.
3+
This project implements a Model Context Protocol (MCP) server that helps you use Hyperweb platform tools better and easier with AI agents.
44

5-
## πŸš€ Features
5+
## Setup
66

7-
- Built with TypeScript for type safety and better developer experience
8-
- Integration with Mistral AI API
9-
- Model Context Protocol SDK integration
10-
- Environment-based configuration
11-
- Modern development tooling (Biome, TypeScript)
7+
To run the Hyperweb MCP server using npx, use the following command:
128

13-
## πŸ“‹ Prerequisites
14-
15-
- Node.js (Latest LTS version recommended)
16-
- pnpm package manager
9+
```bash
10+
npx -y @shopify/dev-mcp@latest
11+
```
1712

1813
## πŸ› οΈ Installation
1914

2015
1. Clone the repository:
16+
2117
```bash
2218
git clone https://github.com/yourusername/agentic-tools.git
2319
cd agentic-tools
2420
```
2521

26-
2. Install dependencies:
22+
1. Install dependencies:
2723
```bash
2824
pnpm install
2925
```
3026

31-
3. Set up environment variables:
27+
1. Set up environment variables:
3228
```bash
3329
cp .env.example .env
3430
```
@@ -38,23 +34,37 @@ Edit the `.env` file with your configuration values.
3834

3935
### Available Scripts
4036

41-
- `pnpm build` - Build the project
37+
- `pnpm build` - Build the project and copy prompts to build directory
4238
- `pnpm clean` - Clean build artifacts
43-
- `pnpm test` - Run tests (to be implemented)
39+
- `pnpm test` - Run tests
40+
- `pnpm inspector` - Run the MCP inspector with the server
41+
- `pnpm format` - Format code using Biome
42+
- `pnpm lint` - Lint code using Biome
43+
44+
### Available Tools
45+
46+
The server provides the following tools:
47+
48+
| Tool Name | Description |
49+
|-----------|-------------|
50+
| starship-config-gen | Generate Starship configuration |
51+
| starship-setup | Setup Starship environment |
4452

4553
### Development Tools
4654

4755
- **TypeScript** - For static typing and modern JavaScript features
4856
- **Biome** - For linting and formatting
4957
- **Model Context Protocol SDK** - For AI model interactions
50-
- **Mistral AI** - For advanced AI capabilities
5158
- **Zod** - For runtime type validation
5259

5360
## πŸ“¦ Project Structure
5461

5562
```
5663
agentic-tools/
5764
β”œβ”€β”€ src/ # Source code
65+
β”‚ └── starship/ # Starship-related tools and prompts
66+
β”‚ β”œβ”€β”€ tools/ # Tool implementations
67+
β”‚ └── prompts/ # Prompt templates
5868
β”œβ”€β”€ build/ # Compiled output
5969
β”œβ”€β”€ .env.example # Example environment variables
6070
└── biome.json # Biome configuration
@@ -71,4 +81,3 @@ This project is licensed under the ISC License - see the LICENSE file for detail
7181
## πŸ™ Acknowledgments
7282

7383
- [Model Context Protocol](https://github.com/modelcontextprotocol/sdk)
74-
- [Mistral AI](https://mistral.ai/)

β€Žpackage.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"test": "vitest",
1111
"test:watch": "vitest --watch",
1212
"test:coverage": "vitest --coverage",
13-
"inspector": "npm run build && npm exec @modelcontextprotocol/inspector build/index.js",
13+
"inspector": "npm run build && npm exec @modelcontextprotocol/inspector node build/index.js",
1414
"format": "biome check --write",
1515
"lint": "biome check"
1616
},

0 commit comments

Comments
Β (0)