hyperterse 1.3.0 → 1.4.0
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 +44 -39
- package/package.json +9 -2
package/README.md
CHANGED
|
@@ -20,10 +20,10 @@ Hyperterse is a high-performance runtime server that transforms database queries
|
|
|
20
20
|
|
|
21
21
|
You describe your queries once, in a simple configuration file. Hyperterse does the rest:
|
|
22
22
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
23
|
+
- Generates individual, typed endpoints
|
|
24
|
+
- Validates inputs automatically
|
|
25
|
+
- Produces OpenAPI documentation
|
|
26
|
+
- Exposes queries safely to AI systems
|
|
27
27
|
|
|
28
28
|
No ORMs. No boilerplate. No exposed SQL.
|
|
29
29
|
|
|
@@ -33,20 +33,20 @@ No ORMs. No boilerplate. No exposed SQL.
|
|
|
33
33
|
|
|
34
34
|
Hyperterse is built with AI in mind.
|
|
35
35
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
36
|
+
- **AI agents and assistants** - Safely query databases through MCP without exposing raw SQL.
|
|
37
|
+
- **LLM tool calling** - Let models discover and invoke database operations autonomously.
|
|
38
|
+
- **Retrieval-augmented generation (RAG)** - Use structured database queries as reliable context.
|
|
39
|
+
- **Conversational interfaces** - Power chatbots that access live business data.
|
|
40
|
+
- **AI-driven analytics** - Enable models to generate insights through validated queries.
|
|
41
|
+
- **Multi-agent systems** - Share consistent database access across agents.
|
|
42
|
+
- **Natural language to SQL pipelines** - Bridge human input and databases using tool calls.
|
|
43
|
+
- **AI dashboards** - Query and visualize data dynamically.
|
|
44
44
|
|
|
45
45
|
### Traditional Use Cases
|
|
46
46
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
47
|
+
- **Database-backed APIs** without boilerplate
|
|
48
|
+
- **Lightweight microservices** without ORM overhead
|
|
49
|
+
- **Rapid prototyping** with configuration-first workflows
|
|
50
50
|
|
|
51
51
|
## Features
|
|
52
52
|
|
|
@@ -70,7 +70,7 @@ Generate REST endpoints, OpenAPI specs, LLM-readable docs, and MCP tools from on
|
|
|
70
70
|
|
|
71
71
|
### Database independence
|
|
72
72
|
|
|
73
|
-
Work across PostgreSQL, MySQL, and Redis using a consistent, unified interface.
|
|
73
|
+
Work across PostgreSQL, MySQL, MongoDB, and Redis using a consistent, unified interface.
|
|
74
74
|
|
|
75
75
|
### Fast and iterative development
|
|
76
76
|
|
|
@@ -96,9 +96,9 @@ curl -fsSL https://hyperterse.com/install | bash
|
|
|
96
96
|
|
|
97
97
|
**Supported platforms:**
|
|
98
98
|
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
99
|
+
- Linux (amd64, arm64, arm)
|
|
100
|
+
- macOS (Intel, Apple Silicon)
|
|
101
|
+
- Windows (amd64, arm64)
|
|
102
102
|
|
|
103
103
|
For more installation options, see the [installation guide](https://docs.hyperterse.com/getting-started/installation).
|
|
104
104
|
|
|
@@ -163,21 +163,22 @@ Response:
|
|
|
163
163
|
|
|
164
164
|
📚 **[Read the docs →](https://docs.hyperterse.com)**
|
|
165
165
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
166
|
+
- **[Getting Started](https://docs.hyperterse.com/getting-started/quick-start)** - Quick start guide and installation
|
|
167
|
+
- **[CLI Reference](https://docs.hyperterse.com/reference/cli)** - Complete command-line interface reference
|
|
168
|
+
- **[Configuration Guide](https://docs.hyperterse.com/reference/configuration)** - Configuration file reference
|
|
169
|
+
- **[Guides](https://docs.hyperterse.com/guides)** - Practical guides for AI integration, OpenAPI, MCP, and caching
|
|
170
|
+
- **[Caching Guide](https://docs.hyperterse.com/guides/caching)** - Executor-level query caching, TTL, and override strategy
|
|
171
|
+
- **[Concepts](https://docs.hyperterse.com/concepts)** - Core concepts: adapters, queries, and inputs
|
|
172
|
+
- **[Databases](https://docs.hyperterse.com/databases)** - Database-specific documentation
|
|
173
|
+
- **[Deployment](https://docs.hyperterse.com/deployment)** - Deployment guides for various platforms
|
|
173
174
|
|
|
174
175
|
### Runtime Endpoints
|
|
175
176
|
|
|
176
177
|
When running, Hyperterse exposes several endpoints:
|
|
177
178
|
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
179
|
+
- **OpenAPI Documentation**: `GET /docs` - Interactive API documentation
|
|
180
|
+
- **LLM Documentation**: `GET /llms.txt` - AI-friendly documentation format
|
|
181
|
+
- **MCP Protocol**: `POST /mcp` - Model Context Protocol JSON-RPC endpoint
|
|
181
182
|
|
|
182
183
|
## Examples
|
|
183
184
|
|
|
@@ -257,6 +258,12 @@ Development mode (hot reload):
|
|
|
257
258
|
hyperterse dev -f config.terse
|
|
258
259
|
```
|
|
259
260
|
|
|
261
|
+
Validate configuration:
|
|
262
|
+
|
|
263
|
+
```bash
|
|
264
|
+
hyperterse validate -f config.terse
|
|
265
|
+
```
|
|
266
|
+
|
|
260
267
|
Generate artifacts:
|
|
261
268
|
|
|
262
269
|
```bash
|
|
@@ -309,10 +316,10 @@ For complete configuration reference, see the [configuration guide](https://docs
|
|
|
309
316
|
|
|
310
317
|
Hyperterse is designed with security as a baseline:
|
|
311
318
|
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
319
|
+
- 🔒 **Credentials are never exposed** - Connection strings stay server-side
|
|
320
|
+
- 🛡️ **SQL is never returned to clients** - Raw queries remain hidden
|
|
321
|
+
- ✅ **Inputs are validated and escaped** - Strong typing prevents injection
|
|
322
|
+
- 🔇 **Errors are sanitized by default** - Internal details stay internal
|
|
316
323
|
|
|
317
324
|
For production deployments, place Hyperterse behind a reverse proxy for authentication, rate limiting, and TLS. See the [production security guide](https://docs.hyperterse.com/security/production) for best practices.
|
|
318
325
|
|
|
@@ -332,17 +339,15 @@ Please keep changes focused and well-tested. For major changes, open an issue fi
|
|
|
332
339
|
|
|
333
340
|
## Support
|
|
334
341
|
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
342
|
+
- 🌐 **Website**: [hyperterse.com](https://hyperterse.com)
|
|
343
|
+
- 📖 **Documentation**: [docs.hyperterse.com](https://docs.hyperterse.com)
|
|
344
|
+
- 🐛 **Issues**: [GitHub Issues](https://github.com/hyperterse/hyperterse/issues)
|
|
345
|
+
- 💬 **Discussions**: [GitHub Discussions](https://github.com/hyperterse/hyperterse/discussions)
|
|
340
346
|
|
|
341
347
|
---
|
|
342
348
|
|
|
343
349
|
<div align="center">
|
|
344
350
|
|
|
345
|
-
|
|
346
351
|
Made with care by the Hyperterse team.
|
|
347
352
|
|
|
348
353
|
[Website](https://hyperterse.com) • [GitHub](https://github.com/hyperterse/hyperterse) • [Documentation](https://docs.hyperterse.com)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "hyperterse",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.4.0",
|
|
4
4
|
"description": "A declarative interface to connect your database to your AI agents",
|
|
5
5
|
"author": "Samrith Shankar <samrith@outlook.com>",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -26,8 +26,15 @@
|
|
|
26
26
|
"database",
|
|
27
27
|
"api",
|
|
28
28
|
"mcp",
|
|
29
|
+
"model context protocol",
|
|
29
30
|
"ai",
|
|
30
|
-
"agents"
|
|
31
|
+
"agents",
|
|
32
|
+
"postgres",
|
|
33
|
+
"mysql",
|
|
34
|
+
"mongodb",
|
|
35
|
+
"redis",
|
|
36
|
+
"skills",
|
|
37
|
+
"rest"
|
|
31
38
|
],
|
|
32
39
|
"engines": {
|
|
33
40
|
"node": ">=14.0.0"
|