lint

Author: pietrozullo

examples/README.md

@@ -15,16 +15,19 @@ This directory contains examples demonstrating how to use the mcp-use library wi
 ## Running Examples
 
 First, build the library:
+
 ```bash
 npm run build
 ```
 
 Then run any example using Node.js:
+
 ```bash
 node dist/examples/example_name.js
 ```
 
 Or use the npm scripts:
+
 ```bash
 npm run example:airbnb
 npm run example:browser
@@ -35,32 +38,42 @@ npm run example:chat
 ## Available Examples
 
 ### 1. Airbnb Search (`airbnb_use.ts`)
+
 Search for accommodations using the Airbnb MCP server.
+
 ```bash
 npm run example:airbnb
 ```
 
 ### 2. Browser Automation (`browser_use.ts`)
+
 Control a browser using Playwright MCP server.
+
 ```bash
 npm run example:browser
 ```
 
 ### 3. Interactive Chat (`chat_example.ts`)
+
 Interactive chat session with conversation memory.
+
 ```bash
 npm run example:chat
 ```
 
 ### 4. File System Operations (`filesystem_use.ts`)
+
 Access and manipulate files using the filesystem MCP server.
+
 ```bash
 # First, edit the example to set your directory path
 npm run example:filesystem
 ```
 
 ### 5. HTTP Server Connection (`http_example.ts`)
+
 Connect to an MCP server via HTTP.
+
 ```bash
 # First, start the Playwright server in another terminal:
 npx @playwright/mcp@latest --port 8931
@@ -70,33 +83,43 @@ npm run example:http
 ```
 
 ### 6. MCP Everything Test (`mcp_everything.ts`)
+
 Test various MCP functionalities.
+
 ```bash
 npm run example:everything
 ```
 
 ### 7. Multiple Servers (`multi_server_example.ts`)
+
 Use multiple MCP servers in a single session.
+
 ```bash
 # First, edit the example to set your directory path
 npm run example:multi
 ```
 
 ### 8. Sandboxed Environment (`sandbox_everything.ts`)
+
 Run MCP servers in an E2B sandbox (requires E2B_API_KEY).
+
 ```bash
 npm run example:sandbox
 ```
 
 ### 9. OAuth Authentication (`simple_oauth_example.ts`)
+
 OAuth flow example with Linear.
+
 ```bash
 # First, register your app with Linear and update the client_id
 npm run example:oauth
 ```
 
 ### 10. Blender Integration (`blender_use.ts`)
+
 Control Blender 3D through MCP.
+
 ```bash
 # First, install and enable the Blender MCP addon
 npm run example:blender
@@ -105,12 +128,14 @@ npm run example:blender
 ## Configuration Files
 
 Some examples use JSON configuration files:
+
 - `airbnb_mcp.json` - Airbnb server configuration
 - `browser_mcp.json` - Browser server configuration
 
 ## Environment Variables
 
 Different examples require different API keys:
+
 - **ANTHROPIC_API_KEY**: For examples using Claude (airbnb, multi_server, blender)
 - **OPENAI_API_KEY**: For examples using GPT (browser, chat, filesystem, http, everything)
 - **E2B_API_KEY**: Only for the sandbox example
@@ -127,12 +152,14 @@ Different examples require different API keys:
 To create a new example:
 
 1. Import the necessary modules:
+
    ```typescript
-   import { MCPAgent, MCPClient } from '../index.js'
    import { ChatOpenAI } from '@langchain/openai'
+   import { MCPAgent, MCPClient } from '../index.js'
    ```
 
 2. Configure your MCP server:
+
    ```typescript
    const config = {
      mcpServers: {
@@ -145,6 +172,7 @@ To create a new example:
    ```
 
 3. Create client, LLM, and agent:
+
    ```typescript
    const client = MCPClient.fromDict(config)
    const llm = new ChatOpenAI({ model: 'gpt-4o' })
@@ -159,7 +187,8 @@ To create a new example:
 ## Contributing
 
 Feel free to add more examples! Make sure to:
+
 1. Follow the existing code style
 2. Add appropriate documentation
 3. Update this README with your example
-4. Add a corresponding npm script in package.json
+4. Add a corresponding npm script in package.json

package.json

@@ -98,8 +98,10 @@
   },
   "lint-staged": {
     "*.{js,ts}": [
-      "eslint --fix",
-      "git add"
+      "npm run lint"
+    ],
+    "**/*.ts": [
+      "npm run build"
     ]
   }
 }