hyperterse 2.4.0 → 2.5.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 +31 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!-- Start of - Dont change this block -->
|
|
2
2
|
<div align="center">
|
|
3
3
|
<picture>
|
|
4
|
-
<img alt="Hyperterse
|
|
4
|
+
<img alt="Hyperterse — The agentic server framework." src="docs/assets/og.png" />
|
|
5
5
|
</picture>
|
|
6
6
|
</div>
|
|
7
7
|
<br />
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
<h1>Hyperterse</h1>
|
|
10
10
|
</div>
|
|
11
11
|
<p align="center">
|
|
12
|
-
<strong>The
|
|
12
|
+
<strong>The agentic server framework.</strong><br />
|
|
13
13
|
<a href="https://hyperterse.com">Website</a>
|
|
14
14
|
•
|
|
15
15
|
<a href="https://docs.hyperterse.com">Documentation</a>
|
|
@@ -25,21 +25,30 @@
|
|
|
25
25
|
|
|
26
26
|
<!-- End of - Dont change this block -->
|
|
27
27
|
|
|
28
|
-
Hyperterse is
|
|
28
|
+
**Hyperterse** is an **agentic server framework**: one build ships **agents** (A2A), **tools** (MCP), **prompts**, **resources**, database adapters, auth, caching, and observability from a single process. You declare surfaces in config; the compiler validates and bundles them. Clients use [MCP](https://modelcontextprotocol.io/) Streamable HTTP at `/mcp` for tools, prompts, and resources; [A2A](https://github.com/a2aproject/a2a-go)-style agent routes live at `/agent/{name}` when you define agents.
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
## Where to start
|
|
31
|
+
|
|
32
|
+
- **Agents** — Declarative agents and A2A: [Agents overview](https://docs.hyperterse.com/agents/overview), [Agents quickstart](https://docs.hyperterse.com/agents/quickstart).
|
|
33
|
+
- **Tools** — Callable MCP tools (DB or scripts): [Tools](https://docs.hyperterse.com/concepts/tools), [Scripts](https://docs.hyperterse.com/concepts/scripts), [Adapters](https://docs.hyperterse.com/concepts/adapters).
|
|
34
|
+
- **Resources** — Static context for clients: [Resources](https://docs.hyperterse.com/concepts/resources).
|
|
35
|
+
- **Prompts** — Reusable prompt templates: [Prompts](https://docs.hyperterse.com/concepts/prompts).
|
|
36
|
+
|
|
37
|
+
The [Quickstart](https://docs.hyperterse.com/quickstart) walks through install, scaffold, and run, then optional MCP tool checks.
|
|
31
38
|
|
|
32
39
|
## What Hyperterse is for
|
|
33
40
|
|
|
34
|
-
-
|
|
35
|
-
-
|
|
36
|
-
-
|
|
41
|
+
- Running **agents** alongside **MCP tools**, **prompts**, and **resources** in one deployable service
|
|
42
|
+
- Exposing database queries and custom logic as MCP tools with declarative config
|
|
43
|
+
- Production **Streamable HTTP** for MCP and **A2A** routes for agents
|
|
44
|
+
- TypeScript handlers and transforms where config alone is not enough
|
|
37
45
|
|
|
38
46
|
## Core capabilities
|
|
39
47
|
|
|
40
|
-
- **
|
|
48
|
+
- **Agents**: declarative configs, tool-access policies, multi-provider models, per-agent A2A HTTP.
|
|
49
|
+
- **Filesystem discovery**: one MCP tool per tool definition; prompts and resources follow the same discover-and-compile model (see [Project structure](https://docs.hyperterse.com/concepts/project-structure)).
|
|
41
50
|
- **Execution models**: DB-backed tools (`use` + `statement`) or script-backed tools (`handler`).
|
|
42
|
-
- **Database adapters**: PostgreSQL, MySQL, MongoDB, Redis.
|
|
51
|
+
- **Database adapters**: PostgreSQL, MySQL, SQLite, MongoDB, Redis.
|
|
43
52
|
- **Per-tool auth**: built-in `allow_all` and `api_key`, plus custom plugins.
|
|
44
53
|
- **In-memory caching**: global defaults + per-tool overrides.
|
|
45
54
|
- **Observability**: OpenTelemetry tracing/metrics + structured logging.
|
|
@@ -100,7 +109,7 @@ Expected response:
|
|
|
100
109
|
{ "success": true }
|
|
101
110
|
```
|
|
102
111
|
|
|
103
|
-
###
|
|
112
|
+
### Optional: list MCP tools
|
|
104
113
|
|
|
105
114
|
```bash
|
|
106
115
|
curl -s -X POST http://localhost:8080/mcp \
|
|
@@ -117,7 +126,7 @@ By design, Hyperterse exposes two transport-layer tools:
|
|
|
117
126
|
- `search` - discover project tools by natural language
|
|
118
127
|
- `execute` - execute a project tool by name
|
|
119
128
|
|
|
120
|
-
###
|
|
129
|
+
### Optional: discover project tools (search)
|
|
121
130
|
|
|
122
131
|
```bash
|
|
123
132
|
curl -s -X POST http://localhost:8080/mcp \
|
|
@@ -247,7 +256,9 @@ Each tool must define exactly one execution mode:
|
|
|
247
256
|
|
|
248
257
|
## Runtime model
|
|
249
258
|
|
|
250
|
-
|
|
259
|
+
**MCP** — Streamable HTTP at `/mcp` (JSON-RPC 2.0): tools, prompts, resources, completion, subscriptions. See [MCP transport](https://docs.hyperterse.com/runtime/mcp-transport).
|
|
260
|
+
|
|
261
|
+
**A2A** — JSON-RPC per agent at `/agent/{agentName}` (agent card, messaging, tasks, streaming). See [A2A transport](https://docs.hyperterse.com/runtime/a2a-transport) and [Agents](https://docs.hyperterse.com/agents/overview).
|
|
251
262
|
|
|
252
263
|
Execution pipeline:
|
|
253
264
|
|
|
@@ -289,16 +300,16 @@ Text content for tool results is supported; image, audio, and resource links are
|
|
|
289
300
|
- [Introduction](https://docs.hyperterse.com/introduction)
|
|
290
301
|
- [Quickstart](https://docs.hyperterse.com/quickstart)
|
|
291
302
|
- [Project structure](https://docs.hyperterse.com/concepts/project-structure)
|
|
292
|
-
- [
|
|
293
|
-
- [
|
|
294
|
-
- [Resources](https://docs.hyperterse.com/concepts/resources)
|
|
295
|
-
- [
|
|
296
|
-
- [
|
|
303
|
+
- **Agents** — [Overview](https://docs.hyperterse.com/agents/overview), [Agents quickstart](https://docs.hyperterse.com/agents/quickstart), [Tool access](https://docs.hyperterse.com/agents/tool-access), [Runtime API](https://docs.hyperterse.com/agents/runtime-api), [Model providers](https://docs.hyperterse.com/agents/model-providers)
|
|
304
|
+
- **Tools** — [Tools](https://docs.hyperterse.com/concepts/tools), [Scripts](https://docs.hyperterse.com/concepts/scripts), [Adapters](https://docs.hyperterse.com/concepts/adapters)
|
|
305
|
+
- **Resources** — [Resources](https://docs.hyperterse.com/concepts/resources)
|
|
306
|
+
- **Prompts** — [Prompts](https://docs.hyperterse.com/concepts/prompts)
|
|
307
|
+
- [Authentication](https://docs.hyperterse.com/concepts/authentication)
|
|
297
308
|
- [MCP transport](https://docs.hyperterse.com/runtime/mcp-transport)
|
|
309
|
+
- [A2A transport](https://docs.hyperterse.com/runtime/a2a-transport)
|
|
298
310
|
- [Execution pipeline](https://docs.hyperterse.com/runtime/execution-pipeline)
|
|
299
311
|
- [CLI reference](https://docs.hyperterse.com/reference/cli)
|
|
300
|
-
- [Prompt config
|
|
301
|
-
- [Resource config reference](https://docs.hyperterse.com/reference/resource-config)
|
|
312
|
+
- [Agent config](https://docs.hyperterse.com/reference/agent-config), [Prompt config](https://docs.hyperterse.com/reference/prompt-config), [Resource config](https://docs.hyperterse.com/reference/resource-config)
|
|
302
313
|
- [Configuration schemas](https://docs.hyperterse.com/reference/configuration-schemas)
|
|
303
314
|
|
|
304
315
|
## Contributing
|
|
@@ -314,7 +325,7 @@ See `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md`.
|
|
|
314
325
|
---
|
|
315
326
|
|
|
316
327
|
<p align="center">
|
|
317
|
-
|
|
328
|
+
Agentic server framework—agents, tools, prompts, resources, one engine.<br />
|
|
318
329
|
<a href="https://hyperterse.com">Website</a>
|
|
319
330
|
•
|
|
320
331
|
<a href="https://github.com/hyperterse/hyperterse">GitHub</a>
|