Skip to content

Commit d63e88e

Browse files
committed
Update README.md
1 parent 767c74a commit d63e88e

1 file changed

Lines changed: 25 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# tinystruct MCP project
1+
# tinystruct MCP project
22

33
**tinystruct MCP** is a demonstration project that showcases how to develop [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) tools using the [tinystruct framework](https://www.tinystruct.org). It provides a modular Java-based MCP server with built-in tools for file system management and GitHub operations.
44

@@ -22,6 +22,8 @@ The project is organized into submodules, each representing a specific domain of
2222

2323
* **`github/`**: Implements Git operations (clone, pull, push, status) and GitHub API integrations (issues, PRs, actions).
2424
* **`filesystem/`**: Provides comprehensive local file system management (read, write, copy, move, delete, list).
25+
* **`database/`**: Provides database connectivity and operations (query, insert, update, delete, describe).
26+
* **`websearch/`**: Provides web search capabilities using DuckDuckGo Instant Answer API.
2527
* **`bin/`**: Contains scripts for server management and dispatching commands.
2628

2729
---
@@ -53,10 +55,10 @@ Use the `bin/dispatcher` (for Linux/macOS) or `bin/dispatcher.cmd` (for Windows)
5355

5456
```sh
5557
# On Linux / macOS
56-
bin/dispatcher start --import org.tinystruct.system.HttpServer --import org.tinystruct.mcp.GitHub --import org.tinystruct.mcp.FileSystem --server-port 777
58+
bin/dispatcher start --import org.tinystruct.system.HttpServer --import org.tinystruct.mcp.GitHub --import org.tinystruct.mcp.FileSystem --import org.tinystruct.mcp.Database --import org.tinystruct.mcp.websearch.WebSearch --server-port 777
5759

5860
# On Windows
59-
bin\dispatcher.cmd start --import org.tinystruct.system.HttpServer --import org.tinystruct.mcp.GitHub --import org.tinystruct.mcp.FileSystem --server-port 777
61+
bin\dispatcher.cmd start --import org.tinystruct.system.HttpServer --import org.tinystruct.mcp.GitHub --import org.tinystruct.mcp.FileSystem --import org.tinystruct.mcp.Database --import org.tinystruct.mcp.websearch.WebSearch --server-port 777
6062
```
6163

6264
#### Programmatic Startup (Java)
@@ -70,6 +72,8 @@ import org.tinystruct.system.ApplicationManager;
7072
import org.tinystruct.system.HttpServer;
7173
import org.tinystruct.mcp.GitHub;
7274
import org.tinystruct.mcp.FileSystem;
75+
import org.tinystruct.mcp.Database;
76+
import org.tinystruct.mcp.websearch.WebSearch;
7377

7478
public class Main {
7579
public static void main(String[] args) {
@@ -79,6 +83,8 @@ public class Main {
7983
ApplicationManager.init();
8084
ApplicationManager.install(new GitHub());
8185
ApplicationManager.install(new FileSystem());
86+
ApplicationManager.install(new Database());
87+
ApplicationManager.install(new WebSearch());
8288
ApplicationManager.install(new HttpServer());
8389

8490
ApplicationManager.call("start", ctx);
@@ -114,6 +120,22 @@ public class Main {
114120
| `filesystem/delete` | Delete a file or directory (recursive support) |
115121
| `filesystem/mkdir` | Create a new directory |
116122

123+
### Database Tool (`database/`)
124+
| Action | Description |
125+
| :--- | :--- |
126+
| `db/list-tables` | List all tables in the connected database |
127+
| `db/describe` | Describe the columns and types of a specific table |
128+
| `db/query` | SELECT rows from a table with optional WHERE and LIMIT |
129+
| `db/insert` | INSERT a row into a table |
130+
| `db/update` | UPDATE rows in a table matching a WHERE clause |
131+
| `db/delete` | DELETE rows from a table matching a WHERE clause |
132+
| `db/execute` | Execute arbitrary SQL |
133+
134+
### WebSearch Tool (`websearch/`)
135+
| Action | Description |
136+
| :--- | :--- |
137+
| `websearch/search` | Perform a web search using DuckDuckGo Instant Answer API |
138+
117139
---
118140

119141
## Developing Your Own Tools

0 commit comments

Comments
 (0)