# @plurid/uitive-mcp

The agent kit over the Model Context Protocol: the same steps as tools any coding agent can call, confined to the project.

Install: `pnpm add @plurid/uitive-mcp`. Guides: [Coding agents](https://uitive.dev/docs/coding-agents).

- [The server](https://uitive.dev/docs/api/mcp#the-server): [`createServer`](https://uitive.dev/docs/api/mcp#createserver), [`ServerOptions`](https://uitive.dev/docs/api/mcp#serveroptions)

## The server

Source: [`server.ts`](https://github.com/plurid/uitive/blob/3cbf3ac33467567dce35b83159d6d3b290f648d3/packages/mcp/src/server.ts)

### createServer

Uitive over the Model Context Protocol: the agent kit's steps as tools, so any coding agent
can integrate Uitive the way the CLI does. Every path stays inside the project root, symbolic
links resolved, and API descriptions come from files unless the network is allowed, since a URL
can carry data out.

```ts
function createServer(options?: ServerOptions): McpServer;
```

Uses: [`ServerOptions`](https://uitive.dev/docs/api/mcp#serveroptions).

### ServerOptions

How the MCP server runs: the project it is confined to, and whether it may use the network.

| Property | Type | Default | Description |
| - | - | - | - |
| `root?` | `string` | `process.cwd()` | The project the server works in; no tool reads or writes outside it. |
| `allowNetwork?` | `boolean` | `false` | Lets tools read API descriptions from URLs, and discovery crawl hosts other than local ones. |
| `version?` | `string` | `'0.0.0'` | Reported to clients. |
