Offorte MCP Server <!-- omit in toc -->

1# Offorte MCP Server <!-- omit in toc -->
2 
3MCP server for Offorte - Create & send proposals using AI.
4 
5This server acts as the bridge between AI agents and Offorte's proposal engine.
6It enables external models to create and send proposals via Offorte.
7Built for automation workflows, the [MCP](https://modelcontextprotocol.io/) makes it easy to integrate proposal actions into AI tools, chat interfaces, and autonomous systems.
8 
9> **Early technology**
10> Please note that MCP (Model Context Protocol) is a new approach to AI integration.
11> While powerful, it's still evolving and may occasionally produce unexpected or undesired results.
12 
13## Table of Contents <!-- omit in toc -->
14 
15- [About Offorte](#about-offorte)
16- [Goals \& Coverage](#goals--coverage)
17- [Prerequisites](#prerequisites)
18- [Available Tools](#available-tools)
19- [MCP Clients](#mcp-clients)
20- [Development](#development)
21 
22## About Offorte
23 
24Offorte is automated proposal software which helps businesses create, send, and track beautiful interactive proposals.
25Built for speed, flexibility, and real-world use, it combines automation and smart workflows without sacrificing the personal touch.
26[Learn more about Offorte](https://www.offorte.com).
27 
28### API <!-- omit in toc -->
29 
30The MCP server is using the Offorte Public API v2.
31Read the [API documentation](https://www.offorte.com/api-docs/) for more information.
32 
33### Demo <!-- omit in toc -->
34 
35Experience the future of proposals: voice-triggered, AI-powered, fully automated.
36See how Offorte connects voice and workflow in [this real demo](https://www.offorte.com/en/blog/proposal-software/handsfree-proposal-sending-with-mcp).
37 
38## Goals & Coverage
39 
40The goal of this project is too create & send proposals using AI via the protocol.
41Because of the experimental character, the full Offorte API is not covered and its limited to the tools needed to create & send proposals.
42Tools which could lead to an LLM updating and deleting stuff are not yet implemented.
43Update and delete commands might be added in the future, based on reallife results & user feedback.
44 
45## Prerequisites
46 
47- Node.js (tested with Node.js `20.x.x`)
48- Offorte API Key (see [Authentication Section](https://www.offorte.com/api-docs/authentication#api-keys) of the Offorte API Docs)
49- PNPM for development
50- `TRANSPORT_TYPE` (optional): Set to `sse` to enable Server-Sent Events (SSE) mode, or leave unset/default for `stdio` (default: `stdio`).
51 
52## Available Tools
53 
54### Context & Setup <!-- omit in toc -->
55 
56- **get_initial_context** – **IMPORTANT:** Must be called before using any other tools to initialize context and get usage instructions
57 
58### Account <!-- omit in toc -->
59 
60- **get_users** – Lists all account users for the current account
61 
62### Automations <!-- omit in toc -->
63 
64- **get_automation_sets** – Lists automation sets which are used as an optional input to create a new proposal
65 
66### Contacts <!-- omit in toc -->
67 
68- **create_contact** – Create a new contact (organisation or person/individual)
69- **get_contact_details** - Get all details for a contact by id
70- **search_contact_organisations** - Search for organisations by name in the contacts
71- **search_contact_people** - Search for people by name in the contacts
72 
73### Favorites <!-- omit in toc -->
74 
75- **get_proposal_templates** – Lists proposal templates which are used as starting points to create new proposals
76 
77### Proposals <!-- omit in toc -->
78 
79- **create_proposal** – Create a new proposal
80- **get_proposal_directories** – Get all proposal directories grouped by status
81- **search_proposals** – Search for proposals by query
82- **send_proposal** – Send a proposal to its assigned contacts
83 
84### Settings <!-- omit in toc -->
85 
86- **get_design_templates** – Lists available design templates which are used to create new proposals
87- **get_email_templates** – Lists available email templates which are used to send proposals
88- **get_text_templates** – Lists available language text templates which are used to create new proposals
89 
90## MCP Clients
91 
92Currently, this MCP server has only been tested with Claude Desktop.
93More client examples will be added in the future.
94 
95### Claude Desktop Configuration <!-- omit in toc -->
96 
97Find your `claude_desktop_config.json` at `Claude > Settings > Developer > Edit Config` and depending on which option you'd like, add **JUST ONE** of the following:
98 
99#### NPX <!-- omit in toc -->
100 
101Running it straight from the npm registry.
102 
103```json
104{
105	"mcpServers": {
106		"offorte-proposals": {
107			"command": "npx",
108			"args": ["-y", "@offorte/mcp-server"],
109			"env": {
110				"OFFORTE_ACCOUNT_NAME": "<YOUR_ACCOUNT_NAME>",
111				"OFFORTE_API_KEY": "<YOUR_TOKEN>"
112			}
113		}
114	}
115}
116```
117 
118#### Local Node <!-- omit in toc -->
119 
120Dependencies should have been installed & the project is build before you use this method (`pnpm install`).
121 
122```json
123{
124	"mcpServers": {
125		"offorte-proposals": {
126			"command": "node",
127			"args": ["/path/to/directory/offorte-mcp-server/dist/server.js"],
128			"env": {
129				"OFFORTE_ACCOUNT_NAME": "<YOUR_ACCOUNT_NAME>",
130				"OFFORTE_API_KEY": "<YOUR_TOKEN>"
131			}
132		}
133	}
134}
135```
136 
137## Development
138 
139To get started, clone the repository and install the dependencies.
140Make sure you have an .env file and it includes the proper values.
141 
142```bash
143git clone https://github.com/offorte/offorte-mcp-server.git
144cd offorte-mcp-server
145pnpm install
146pnpm dev
147```
148 
149### Commands <!-- omit in toc -->
150 
151Check the NPM scripts for all commands, below is a short summary of the most important onces.
152 
153| Script         | Info                                  |
154| -------------- | ------------------------------------- |
155| `pnpm build`   | Build the project for production      |
156| `pnpm start`   | Start the production server           |
157| `pnpm dev`     | Start the development server          |
158| `pnpm inspect` | Inspect the server                    |
159| `pnpm format`  | Format code using Prettier and ESLint |
160