Manage MCP connections with a simple REST API - OAuth, tokens, and sessions handled for you.
The Smithery Connect is Smithery’s managed service for connecting to MCP servers. Instead of implementing the MCP protocol directly, handling OAuth flows, and managing credentials yourself, Smithery Connect provides a simple REST interface that handles all of this for you.
Some MCP servers require configuration like API keys or project IDs. How you pass each config value depends on the server’s schema — some values go as headers (typically API keys), while others go as query parameters in the MCP URL.Check the server’s page on smithery.ai to see what configuration it requires and where each value should go.
TypeScript
cURL
Copy
Ask AI
import Smithery from '@smithery/api';import { createConnection } from '@smithery/api/mcp';const smithery = new Smithery();// 1. Create a connection with the server's config// - API keys go in `headers`// - Other config goes as query params in `mcpUrl`const conn = await smithery.experimental.connect.connections.set('my-browserbase', { namespace: 'my-app', mcpUrl: 'https://server.smithery.ai/@browserbasehq/mcp-browserbase?browserbaseProjectId=your-project-id', headers: { 'browserbaseApiKey': 'your-browserbase-api-key', },});// conn.status.state === "connected" — ready to use immediately// 2. Get a transport for the connectionconst { transport } = await createConnection({ client: smithery, namespace: 'my-app', connectionId: conn.connectionId,});
Unlike OAuth-based servers that return auth_required, servers configured with API keys return connected immediately.
Each server’s config schema specifies whether a field is passed as a header or query parameter via the x-from metadata. See Session Configuration for details on how servers declare their config transport.
When your agent serves multiple users, you’ll need to track which connections belong to which user. Use the metadata field to associate connections with your users, then filter by metadata to retrieve a specific user’s connections.
When your agent needs to know what tools are available for a user, list their connections:
Copy
Ask AI
const connections = await smithery.experimental.connect.connections.list('my-app', { metadata: { userId: 'user-123' }});// Show the user their connected integrationsfor (const conn of connections.data) { console.log(`${conn.name}: ${conn.status}`);}
A namespace is a globally unique identifier that groups your connections. Create one namespace per application or environment (e.g., my-app, my-app-staging). If you don’t specify a namespace, the SDK uses your first existing namespace or creates one automatically.
A connection is a long-lived session to an MCP server that persists until terminated. Each connection:
Has a connectionId (developer-defined or auto-generated)
Stores credentials securely (write-only—credentials can never be read back, only used to execute requests)
Can include custom metadata for filtering (e.g., userId to associate connections with your users)
Returns serverInfo with the MCP server’s name and version
createConnection Options
Option
Type
Description
client
Smithery?
The Smithery client instance. If not provided, auto-created using SMITHERY_API_KEY env var
mcpUrl
string?
The MCP server URL. Required when connectionId is not provided
namespace
string?
If omitted, uses first existing namespace or creates one
connectionId
string?
If omitted, an ID is auto-generated
Returns a SmitheryConnection with { transport, connectionId, url }.
Throws SmitheryAuthorizationError if OAuth authorization is required (see Handling Authorization).
Create a connection—the response status will be auth_required with an authorizationUrl
Redirect the user to authorizationUrl
User completes OAuth with the upstream provider (e.g., GitHub)
User is redirected back to your app
The connection is now ready—subsequent requests will succeed
You don’t need to register OAuth apps, configure redirect URIs, or handle token exchange. Smithery manages the OAuth relationship with upstream providers and stores credentials securely on your behalf.
When using the SDK, createConnection() throws a SmitheryAuthorizationError if the MCP server requires OAuth. The error contains the URL to redirect the user to and the connection ID to retry with after authorization completes.
Copy
Ask AI
import { createConnection, SmitheryAuthorizationError } from '@smithery/api/mcp';try { const { transport } = await createConnection({ mcpUrl: 'https://server.smithery.ai/@anthropic/github', }); // Connection succeeded — use transport as normal const mcpClient = await createMCPClient({ transport }); const tools = await mcpClient.tools();} catch (error) { if (error instanceof SmitheryAuthorizationError) { // Redirect the user to complete OAuth // error.authorizationUrl — where to send the user // error.connectionId — save this to retry after auth completes redirect(error.authorizationUrl); } throw error;}
After the user completes authorization and returns to your app, retry with the saved connectionId:
Copy
Ask AI
const { transport } = await createConnection({ connectionId: savedConnectionId,});const mcpClient = await createMCPClient({ transport });const tools = await mcpClient.tools();
Service tokens let you safely use the Smithery Connect from browsers, mobile apps, and AI agents without exposing your API key. Your backend mints a scoped token, then your client uses it to call tools directly.
TypeScript
cURL
Copy
Ask AI
// Create a token scoped to a specific user's connectionsconst { token } = await smithery.tokens.create({ policy: [ { namespaces: 'my-app', resources: 'connections', operations: ['read', 'execute'], metadata: { userId: 'user-123' }, ttl: '1h', }, ],})// Send `token` to your client — safe for browser use