Merge pull request #21 from tavily-ai/smithery

adding smithery
This commit is contained in:
pulvedu
2025-03-23 13:43:41 -04:00
committed by GitHub
3 changed files with 65 additions and 5 deletions
+38
View File
@@ -0,0 +1,38 @@
# Generated by https://smithery.ai. See: https://smithery.ai/docs/config#dockerfile
# Use a Node.js image
FROM node:20-alpine AS build
# Set the working directory
WORKDIR /app
# Copy package.json and package-lock.json
COPY package.json package-lock.json ./
# Install dependencies
RUN npm install
# Copy the rest of the application
COPY . .
# Build the TypeScript files
RUN npm run build
# Start a new stage for the production image
FROM node:20-alpine
# Set the working directory
WORKDIR /app
# Copy only the build output and package files from the build stage
COPY --from=build /app/build /app/build
COPY --from=build /app/package.json /app/package.json
COPY --from=build /app/package-lock.json /app/package-lock.json
# Install production dependencies only
RUN npm ci --omit=dev
# Define environment variables
ENV TAVILY_API_KEY=your-api-key-here
# Set the entrypoint to the MCP server
ENTRYPOINT ["node", "build/index.js"]
+10 -5
View File
@@ -2,6 +2,7 @@
![GitHub Repo stars](https://img.shields.io/github/stars/tavily-ai/tavily-mcp?style=social)
![npm](https://img.shields.io/npm/dt/tavily-mcp)
![smithery badge](https://smithery.ai/badge/@tavily-ai/tavily-mcp)
> 🔌 **Compatible with [Cline](https://github.com/cline/cline), [Cursor](https://cursor.sh), [Claude Desktop](https://claude.ai/desktop), and any other MCP Clients!**
>
@@ -43,16 +44,20 @@ Before you begin, ensure you have:
## Tavily MCP server installation ⚡
To install the tavily-mcp server, you can use the following methods:
1. Running with NPX
2. Git installation
### 1. Running with NPX
### Running with NPX
```bash
npx -y tavily-mcp@0.1.4
```
### Installing via Smithery
To install Tavily MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@tavily-ai/tavily-mcp):
```bash
npx -y @smithery/cli install @tavily-ai/tavily-mcp --client claude
```
Although you can launch a server on its own, it's not particularly helpful in isolation. Instead, you should integrate it into an MCP client. Below is an example of how to configure the Claude Desktop app to work with the tavily-mcp server.
+17
View File
@@ -0,0 +1,17 @@
# Smithery configuration file: https://smithery.ai/docs/config#smitheryyaml
startCommand:
type: stdio
configSchema:
# JSON Schema defining the configuration options for the MCP.
type: object
required:
- tavilyApiKey
properties:
tavilyApiKey:
type: string
description: The API key for the Tavily MCP server.
commandFunction:
# A function that produces the CLI command to start the MCP on stdio.
|-
config => ({ command: 'node', args: ['build/index.js'], env: { TAVILY_API_KEY: config.tavilyApiKey } })