> ## Documentation Index
> Fetch the complete documentation index at: https://mcp-use.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

<AgentInstructions>

## Submitting Feedback

If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:

POST https://mcp-use.com/docs/feedback

```json
{
  "path": "/typescript/getting-started/installation",
  "feedback": "Description of the issue"
}
```

Only submit feedback when you have something specific and actionable to report.

</AgentInstructions>

# Installation

> Install mcp_use and get your development environment ready

<Info>
  **Prerequisites**:

  * Install [Node.js](https://nodejs.org/) (version 18 or higher)
  * npm, pnpm, or yarn package manager
</Info>

### MCP Servers

The fastest way to scaffold a new MCP server project is to use `create-mcp-use-app`:

<CodeGroup>
  ```bash npm theme={null}
  npx create-mcp-use-app my-mcp-server
  cd my-mcp-server
  npm run dev
  ```

  ```bash pnpm theme={null}
  pnpm create mcp-use-app my-mcp-server
  cd my-mcp-server
  pnpm dev
  ```

  ```bash yarn theme={null}
  yarn create mcp-use-app my-mcp-server
  cd my-mcp-server
  yarn dev
  ```
</CodeGroup>

This command will:

* Create a new directory with your project name
* Initialize a TypeScript project with mcp-use configured
* Set up a basic MCP server template with example tools
* Optionally install all dependencies
* Optionally install skills for agent support

<Tip>
  Check out [UI Widgets](/typescript/server/mcp-apps) with support to MCP-UI and OpenAI Apps SDK for ChatGPT.
</Tip>

### Server Metadata

The generated project includes pre-configured server metadata that is visible in MCP Inspector and MCP clients:

* **Name & Title**: Both set to your project name (customizable in `index.ts`)
* **Icons**: mcp-use branding icons included in `public/` folder
* **Website URL**: Defaults to [https://mcp-use.com](https://mcp-use.com) (customizable)
* **Favicon**: Included for browser display

These settings appear in:

* MCP Inspector UI (server dropdown and "View server info" modal)
* MCP clients that support server metadata
* ChatGPT when using your server as an app

**Customizing Server Metadata:**

Open `index.ts` in your project to customize:

```typescript theme={null}
const server = new MCPServer({
  name: 'my-project',          // Set by create-mcp-use-app
  title: 'My Custom Title',    // display name - shown in clients
  version: '1.0.0',
  description: 'My awesome server',
  websiteUrl: 'https://my-site.com',  // Your website or docs
  favicon: 'favicon.ico',      // Already in public/ folder
  icons: [
    {
      src: 'my-icon.svg',      // Add custom icon to public/ folder
      mimeType: 'image/svg+xml',
      sizes: ['512x512']
    }
  ]
})
```

**Note:** Icon paths (like `icon.svg`) are automatically converted to absolute URLs (e.g., `http://localhost:3000/mcp-use/public/icon.svg`) when `baseUrl` is configured.

***

You can also install mcp-use as a library and build your own MCP server from scratch.

<CodeGroup>
  ```bash npm theme={null}
  npm install mcp-use
  ```

  ```bash pnpm theme={null}
  pnpm add mcp-use
  ```

  ```bash yarn theme={null}
  yarn add mcp-use
  ```
</CodeGroup>

```typescript theme={null}
import { MCPServer } from "mcp-use/server";
import { z } from "zod";

const server = new MCPServer({
  name: "my-server",
  title: "My Server", // display name
  version: "1.0.0",
  description: "My custom MCP server",
  websiteUrl: "https://mcp-use.com",
  favicon: "favicon.ico",
  icons: [
    {
      src: "icon.svg",
      mimeType: "image/svg+xml",
      sizes: ["512x512"]
    }
  ]
});

// Define a tool
server.tool("get_weather", {
  description: "Get weather for a city",
  parameters: z.object({
    city: z.string().describe("City name"),
  }),
  execute: async ({ city }) => {
    return { temperature: 72, condition: "sunny", city };
  },
});

// Start server with auto-inspector
server.listen(3000);
// 🎉 Inspector at http://localhost:3000/inspector
```

Check out the examples [here](https://github.com/mcp-use/mcp-use/tree/main/examples/server).

Visit the [MCP Server](/typescript/server) documentation for more details.

### MCP Agent & Client

Install mcp\_use using your preferred package manager:

<CodeGroup>
  ```bash npm theme={null}
  npm install mcp-use
  ```

  ```bash pnpm theme={null}
  pnpm add mcp-use
  ```

  ```bash yarn theme={null}
  yarn add mcp-use
  ```
</CodeGroup>

## Next Steps

<CardGroup cols={3}>
  <Card title="Agent" icon="brain" href="/typescript/agent">
    Build AI Agents with tool calling capabilities through MCP connections
  </Card>

  <Card title="Client" icon="router" href="/typescript/client">
    A full featured MCP Client implementation for TypeScript
  </Card>

  <Card title="Server" icon="server" href="/typescript/server">
    The MCP Server framework implementation for TypeScript, with Apps SDK and MCP-UI support
  </Card>
</CardGroup>

<Tip>
  **Need Help?** Join our [Discord](https://discord.gg/XkNkSkMz3V) or [Github](https://github.com/mcp-use/mcp-use) communities.
</Tip>