Skip to content

add VS Code instructions #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

add VS Code instructions #50

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
671ff53
add VS Code instructions
Apr 4, 2025
5deabf0
Update README.md
mbaiza27 Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,65 @@ How Firecrawl works:

Note: A `FIRECRAWL_API_KEY` environment variable must be set to use these functions.

## VS Code Integration

For one-click installation, click one of the install buttons below:

[![Install with UV in VS Code](https://img.shields.io/badge/VS_Code-UV-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=uns-mcp&config=%7B%22command%22%3A%22uv%22%2C%22args%22%3A%5B%22run%22%2C%22server.py%22%5D%2C%22env%22%3A%7B%22UNSTRUCTURED_API_KEY%22%3A%22%24%7Binput%3AapiKey%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apiKey%22%2C%22description%22%3A%22Unstructured+API+Key%22%2C%22password%22%3Atrue%7D%5DD) [![Install with UV in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-UV-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=uns-mcp&config=%7B%22command%22%3A%22uv%22%2C%22args%22%3A%5B%22run%22%2C%22server.py%22%5D%2C%22env%22%3A%7B%22UNSTRUCTURED_API_KEY%22%3A%22%24%7Binput%3AapiKey%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apiKey%22%2C%22description%22%3A%22Unstructured+API+Key%22%2C%22password%22%3Atrue%7D%5D&quality=insiders)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution!
I clicked on both of the banners, and I see "invalid config." What should I see here?
How are these redirect URLs generated?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @plutasnyy,

There was a small typo in the "Install with UV in VS Code" button. It is now fixed.

The buttons should re-direct you to your local install of VS Code / VS Code Insiders (depending on which one was clicked) and a UI element should pop up asking you to add the MCP server.

As for how the URLs are generated our eng team created a URL generator for this use case, the error came from a mis-click after I pasted the link in😄


### Manual Installation

For manual installation, first make sure you've installed all dependencies as described in the Setup section above.

Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.

```json
{
"mcp": {
"inputs": [
{
"type": "promptString",
"id": "apiKey",
"description": "Unstructured API Key",
"password": true
}
],
"servers": {
"uns-mcp": {
"command": "uv",
"args": ["run", "server.py"],
"env": {
"UNSTRUCTURED_API_KEY": "${input:apiKey}"
}
}
}
}
}
```

Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others.

```json
{
"inputs": [
{
"type": "promptString",
"id": "apiKey",
"description": "Unstructured API Key",
"password": true
}
],
"servers": {
"uns-mcp": {
"command": "uv",
"args": ["run", "server.py"],
"env": {
"UNSTRUCTURED_API_KEY": "${input:apiKey}"
}
}
}
}
```

## Claude Desktop Integration

Expand Down