@aigne/example-mcp-sqlite 1.6.0 → 1.7.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 +8 -7
- package/index.ts +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -60,17 +60,18 @@ AI ->> User: There are 10 products in the database.
|
|
|
60
60
|
## Prerequisites
|
|
61
61
|
|
|
62
62
|
- [Node.js](https://nodejs.org) and npm installed on your machine
|
|
63
|
-
- [
|
|
64
|
-
- [OpenAI API key](https://platform.openai.com/api-keys) used to interact with OpenAI API
|
|
63
|
+
- An [OpenAI API key](https://platform.openai.com/api-keys) for interacting with OpenAI's services
|
|
65
64
|
- [uv](https://github.com/astral-sh/uv) python environment for running [MCP Server SQlite](https://github.com/modelcontextprotocol/servers/tree/main/src/sqlite)
|
|
66
|
-
-
|
|
65
|
+
- Optional dependencies (if running the example from source code):
|
|
66
|
+
- [Bun](https://bun.sh) for running unit tests & examples
|
|
67
|
+
- [Pnpm](https://pnpm.io) for package management
|
|
67
68
|
|
|
68
|
-
##
|
|
69
|
+
## Quick Start (No Installation Required)
|
|
69
70
|
|
|
70
71
|
```bash
|
|
71
|
-
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY #
|
|
72
|
+
export OPENAI_API_KEY=YOUR_OPENAI_API_KEY # Set your OpenAI API key
|
|
72
73
|
|
|
73
|
-
npx -y @aigne/example-mcp-sqlite #
|
|
74
|
+
npx -y @aigne/example-mcp-sqlite # Run the example
|
|
74
75
|
```
|
|
75
76
|
|
|
76
77
|
## Installation
|
|
@@ -94,7 +95,7 @@ pnpm install
|
|
|
94
95
|
Setup your OpenAI API key in the `.env.local` file:
|
|
95
96
|
|
|
96
97
|
```bash
|
|
97
|
-
OPENAI_API_KEY="" #
|
|
98
|
+
OPENAI_API_KEY="" # Set your OpenAI API key here
|
|
98
99
|
```
|
|
99
100
|
|
|
100
101
|
### Run the Example
|
package/index.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aigne/example-mcp-sqlite",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.7.1",
|
|
4
4
|
"description": "A demonstration of using AIGNE Framework and Sqlite MCP Server to interact with a SQLite database",
|
|
5
5
|
"author": "Arcblock <blocklet@arcblock.io> https://github.com/blocklet",
|
|
6
6
|
"homepage": "https://github.com/AIGNE-io/aigne-framework/tree/main/examples/mcp-sqlite",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"openai": "^4.94.0",
|
|
20
20
|
"zod": "^3.24.2",
|
|
21
|
-
"@aigne/cli": "^1.
|
|
22
|
-
"@aigne/core": "^1.
|
|
21
|
+
"@aigne/cli": "^1.5.1",
|
|
22
|
+
"@aigne/core": "^1.10.0"
|
|
23
23
|
},
|
|
24
24
|
"scripts": {
|
|
25
25
|
"start": "bun run index.ts",
|