Skip to content

Commit 765ccae

Browse files
committed
Add ToolHive packaged usage instructions
- Add instructions for running OSV MCP server using ToolHive's packaged 'osv' server - Include ToolHive installation and auto-discovery setup - Reorganize usage section to highlight ToolHive as recommended approach - Maintain existing source-based installation instructions
1 parent 208af29 commit 765ccae

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,31 @@ task build
3131

3232
## Usage
3333

34+
### Running with ToolHive (Recommended)
35+
36+
The easiest way to run the OSV MCP server is using [ToolHive](https://github.com/stacklok/toolhive), which provides secure, containerized deployment of MCP servers:
37+
38+
```bash
39+
# Install ToolHive (if not already installed)
40+
# See: https://github.com/stacklok/toolhive#installation
41+
42+
# Enable auto-discovery to automatically configure supported clients
43+
thv config auto-discovery true
44+
45+
# Run the OSV MCP server (packaged as 'osv' in ToolHive)
46+
thv run osv
47+
48+
# List running servers
49+
thv list
50+
51+
# Get detailed information about the server
52+
thv registry info osv
53+
```
54+
55+
The server will be available to your MCP-compatible clients and can query the OSV database for vulnerability information.
56+
57+
### Running from Source
58+
3459
### Server Configuration
3560

3661
The server can be configured using environment variables:

0 commit comments

Comments
 (0)