new docs revamped for Jan v0.5.18-rc

This commit is contained in:
Ramon Perez 2025-06-11 17:17:45 +10:00
parent 96492f6a1a
commit a88b97c875
11 changed files with 138 additions and 62 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.6 MiB

After

Width:  |  Height:  |  Size: 2.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 337 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 439 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 284 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 514 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 168 KiB

After

Width:  |  Height:  |  Size: 447 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 168 KiB

After

Width:  |  Height:  |  Size: 679 KiB

View File

@ -19,4 +19,127 @@ keywords:
--- ---
import { Callout, Steps } from 'nextra/components' import { Callout, Steps } from 'nextra/components'
# MCP # Using the Model Context Protocol (MCP) in Jan
Jan now supports the **Model Context Protocol (MCP)**, an open standard designed to allow language models to
interact with external tools and data sources.
MCP acts as a common interface, standardizing the way an AI model requests to perform an action and how it
receives data from a tool. This enables a model to connect to any MCP-compliant tool without requiring custom integration work.
This document outlines the benefits, risks, and implementation of MCP within Jan.
## Core Benefits of MCP
Integrating MCP provides a structured way to extend the capabilities of the models you use in Jan. Here are the three
* **Standardization:** MCP aims to solve the "M x N" integration problem, where every model (M) needs a
unique connector for every tool (N). By adapting to a single standard, any compliant model can interface with any compliant tool.
* **Extensibility:** This allows you to augment your models with new abilities. For instance, an AI can be granted
access to search your local codebase, query a database, or interact with web APIs, all through the same protocol.
* **Flexibility:** Because the interface is standardized, you can swap out models or tools with minimal friction,
making your workflows more modular and adaptable over time.
<Callout type="warning">
Please note that not all models that you can download and use, whether in Jan or other tools, may be good at
tool calling or compatible with MCP. Make sure that the model you choose is MCP-compliant before integrating
it into your workflows. This might be available in the model card or you may need to implement it yourself to
test the capabilities of the model.
</Callout>
## Considerations and Risks
While powerful, MCP is an evolving standard, and its use requires careful consideration of the following points:
* **Security:** Granting a model access to external tools is a significant security consideration. A compromised
tool or a malicious prompt could potentially lead to unintended actions or data exposure. Jan's implementation
focuses on user-managed permissions to mitigate this risk, meaning, you have to turn on the permission for each
tool individually.
* **Standard Maturity:** As a relatively new protocol, best practices or sensible defaults are still being
established. Users should be aware of potential issues like prompt injection, where an input could be crafted to
misuse a tool's capabilities.
* **Resource Management:** Active MCP connections may consume a portion of a model's context window, which could
affect performance (i.e., the more tools the model and the larger the context of the conversationhas the longer
you will need to wait for a response). Efficient management of tools and their outputs is important.
## Configure and Use MCPs in Jan
We have integrated an MCP client into Jan to help users in connecting tools to their workflows.
### 0. Pre Setup
You will need to have `node` and/or `python` installed on your machine. If you don't have them installed, you can
download them from the official websites:
- [Node.js](https://nodejs.org/)
- [Python](https://www.python.org/)
### 1. Initial Setup
Before connecting to a tool, you must first enable Jan's MCP host. Navigate to `Settings` > `MCP Servers` and toggle
the `Enable MCP Host` switch.
![Turn on the MCP Host](./_assets/mcp-on.png)
### 2. Adding an MCP Server
Once the host is enabled, you can connect Jan to one or more MCP tool servers.
- Click on the `+` sign on the upper right-hand corner of the MCP box.
![Add New Server](./_assets/mcp-setup-1.png)
- Enter the following details to configure the BrowserMCP:
- **Server Name**: `browsermcp`
- **Command**: `npx`
- **Arguments**: `@browsermcp/mcp`
- **Environment Variables**: You can leave this field empty.
![Configure BrowserMCP](./_assets/mcp-setup-2.png)
- Check that the server has been activated successfully.
![Server Confirmation](./_assets/mcp-setup-3.png)
### 3. Using an MCP Tool in a Chat
With a server connected, models that support tool use can now request access to your configured MCP. As of now,
the best models to use MCP are Claude 4 Sonnet, 4 Opus
#### 3.1 Local Models
- Start a chat with a model capable of tool use and enable tool calling via the UI.
#### 3.2 Cloud-based Models
- Go to **Model Providers > Anthropic** and, after you have entered your API key, enable tool
calling via the UI.
![Enable Tool Calling](./_assets/mcp-setup-4.png)
- Open up a new chat with, say, Claude 4 Sonnet, and send a request that requires the model to use the browser.
![Start Chatting](./_assets/mcp-setup-5.png)
## Troubleshooting
[This is a place for you to add solutions to common problems. For example:]
* **Problem:** The MCP server appears as "Disconnected."
* **Solution:** [Your troubleshooting steps here. e.g., "Verify the server address is correct and that the server is running on your machine. Check for firewall rules that may be blocking the connection..."]
* **Problem:** A model is not attempting to use any tools.
* **Solution:** [Your troubleshooting steps here. e.g., "Ensure the model you are using supports tool-use. Not all models have this capability..."]
## Future Potential
This integration is the foundation for creating more capable and context-aware AI assistants within Jan. The long-term
goal is to enable complex workflows that leverage your local environment securely.
For example, an AI could cross-reference information between a local document and a remote API, or use a local script to
analyze data and then summarize the findings, all orchestrated through Jan's interface. As the MCP ecosystem grows, so
will the potential applications within Jan.

View File

@ -1,6 +1,6 @@
--- ---
title: Settings title: Settings
description: Explore how to adjust the advanced settings of the Jan application to suit your specific requirements. description: Explore how to adjust Jan's settings to suit your specific requirements.
keywords: keywords:
[ [
Jan, Jan,
@ -26,36 +26,7 @@ import { Settings, EllipsisVertical, Plus, FolderOpen, Pencil } from 'lucide-rea
# Settings # Settings
This guide explains how to customize your Jan application settings. To access **Settings**, click <Settings width={16} height={16} style={{display:"inline"}}/> icon in the bottom left corner of Jan. To access the **Settings**, click <Settings width={16} height={16} style={{display:"inline"}}/> icon in the bottom left corner of Jan.
## Navigation Overview
The Settings sidebar includes:
- **General**
- **Appearance**
- **Privacy**
- **Model Providers**
- **Shortcuts**
- **Hardware**
- **MCP Servers**
- **Local API Server**
- **HTTPS Proxy**
- **Extensions**
## Appearance
Customize Jan's look and feel:
- **Theme:**
- Dark
- Light
- System (follows OS preference)
- **Font Size:**
- Small
- Medium
- Large
- Extra Large
- **Color Customization:**
- Window background, main view, primary, accent, destructive (choose from palette)
## Model Management ## Model Management
@ -149,18 +120,6 @@ To change:
![Appearance](./_assets/settings-04.png) ![Appearance](./_assets/settings-04.png)
<br/> <br/>
### Chat Width
Adjust how chat content is displayed.
1. In **Chat Width** section, select either
- **Full Width:** Maximizes the chat area to use the full width of the window. This is ideal for viewing longer messages or when working with code snippets that benefit from more horizontal space.
- **Compact Width:** Creates a more focused chat experience with a narrower conversation view. This setting is useful for reading conversations more comfortably, especially on larger screens.
2. Changes apply immediately to your conversation view
<br/>
![Chat Width](./_assets/settings-05.png)
<br/>
### Spell Check ### Spell Check
Jan includes a built-in spell check feature to help catch typing errors in your messages. Jan includes a built-in spell check feature to help catch typing errors in your messages.
1. Switch the toggle on to enable spell checking, or off to disable it 1. Switch the toggle on to enable spell checking, or off to disable it
@ -407,9 +366,3 @@ To begin the process:
<br/> <br/>
![Jan Quick Ask](./_assets/settings-18.png) ![Jan Quick Ask](./_assets/settings-18.png)
<br/> <br/>