Skip to content

Commit d27aa12

Browse files
committed
Release v1.0.10: Update README files, fix localization, bump version
1 parent be1a280 commit d27aa12

File tree

6 files changed

+251
-53
lines changed

6 files changed

+251
-53
lines changed

README.en.md

Lines changed: 123 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,114 @@
44

55
**Model Context Protocol Server for Forterro Proffix Px5 ERP**
66

7+
The universal interface for AI integration with your Proffix Px5 ERP
8+
79
Connect AI assistants (Claude, ChatGPT, Gemini) to your Proffix Px5 via standardized MCP protocol.
810

9-
## 🌟 Features
11+
**JSON-RPC 2.0 Transport • Parameter-based Auth • Prepared Proffix Endpoints**
12+
13+
## 🌟 What is the Model Context Protocol (MCP)?
14+
15+
Model Context Protocol (MCP) is an open standard by Anthropic for secure AI integration. AI assistants access your systems directly - without manual data copies or screenshots.
16+
17+
**Without MCP:** "Show me all open invoices" → You must open Proffix, export data, copy it into the AI
18+
19+
**With MCP:** "Show me all open invoices" → The AI accesses Proffix directly and delivers the answer
20+
21+
- **Real-time Access:** AI works with current data from your systems
22+
- **Security:** No data is stored in the AI - only temporary access
23+
- **Automation:** AI can perform complex tasks across multiple systems
24+
- **Natural Language:** No SQL or API knowledge required
25+
- **Standardized:** Works with all MCP-compatible AI assistants
26+
27+
## 📋 What is pfx MCP?
28+
29+
pfx MCP is the first MCP Server for Forterro Proffix Px5. Connect AI assistants like Claude, ChatGPT and Gemini to your ERP. Access data, create reports and automate workflows - directly via natural language.
1030

1131
- **Proffix Functionality** directly via MCP Tools
1232
- **JSON-RPC 2.0 Transport** for all MCP clients
13-
- **Secure Authentication** (API Key + Proffix Credentials)
14-
- **Zero Installation** - Remote server, no local installation needed
33+
- **Free API Key** (Beta)
34+
- **Claude, ChatGPT, Gemini Ready**
35+
36+
**Officially listed in the MCP Registry:**
37+
- 📦 Package: `ch.pfx/mcp-server`
38+
- 🔗 Registry: [registry.modelcontextprotocol.io](https://registry.modelcontextprotocol.io)
39+
- 💻 GitHub: [github.com/pitwch/pfx-mcp-server](https://github.com/pitwch/pfx-mcp-server)
40+
- ✅ Status: Active • Version 1.0.0 • Published 2025-11-08
41+
42+
## 💡 Practical Use Cases
43+
44+
### 📊 Intelligent Data Queries
45+
**Example:** "Show me all open invoices"
46+
47+
The AI accesses your Proffix data directly and delivers structured results - without SQL or API knowledge.
48+
49+
### 🔍 Complex Searches
50+
**Example:** "Search for articles with 'Laptop' in the name and price under 1000 CHF"
51+
52+
Natural language queries are automatically converted into precise API calls.
53+
54+
### 📈 Automatic Reports
55+
**Example:** "Create a report on the top 10 customers by revenue"
56+
57+
The AI aggregates data, creates analyses and formats results professionally.
58+
59+
### 🔔 Change Tracking
60+
**Example:** "Which addresses changed this week?"
61+
62+
Time-based queries and change analyses in real-time.
63+
64+
### 💼 More Use Cases
65+
- **Inventory Management:** "Show me all articles with stock below 10"
66+
- **Customer Analysis:** "Analyze the revenue development of customer 1001"
67+
- **Workflow Automation:** "Create a new address for company XY"
68+
- **Endpoint Discovery:** "Which API endpoints are available for orders?"
69+
- **Multi-System Queries:** "Compare Proffix data with our CRM"
1570

1671
## 🚀 Quick Start
1772

1873
### Option 1: One-Click Installation (Recommended) 🎯
1974

2075
**For Claude Desktop Users - Easiest Installation!**
2176

22-
1. **Request API Key**
23-
Get your free API key: [https://mcp.pfx.ch/request-api-key.html](https://mcp.pfx.ch/request-api-key.html)
77+
The fastest method - no manual configuration needed!
78+
79+
1. **Get API Key**
80+
Visit [request-api-key.html](https://mcp.pfx.ch/request-api-key.html) and request your free key (via email)
2481

2582
2. **Download MCPB Bundle**
26-
Download: [pfx-mcp-server.mcpb](https://github.com/pitwch/pfx-mcp-server/releases/latest/download/pfx-mcp-server.mcpb)
83+
[Download pfx-mcp-server.mcpb](https://github.com/pitwch/pfx-mcp-server/releases/latest/download/pfx-mcp-server.mcpb)
2784

2885
3. **Install**
29-
- Double-click the `.mcpb` file
30-
- Claude Desktop automatically opens the installation dialog
31-
- Enter your Proffix credentials (API Key, Username, Password, URL, Port, Database)
32-
- Done! ✅
86+
In Claude Desktop: Settings → Extensions → Advanced Settings (Extension Developer section) → Install Extension… → select the `.mcpb` file and follow instructions
87+
88+
4. **Enter Credentials**
89+
API Key + your Proffix Px5 Credentials (Username, Password, URL, Port, Database)
3390

34-
4. **Restart Claude Desktop**
35-
Ask Claude: *"Show me all addresses from Proffix"*
91+
5. **Done!**
92+
Restart Claude and test: *"Show me all addresses from Zurich from Proffix Px5"*
3693

3794
---
3895

3996
### Option 2: Manual Installation (Advanced) ⚙️
4097

4198
**For other MCP clients or advanced configuration**
4299

100+
For other MCP clients (Cursor, Windsurf, Gemini CLI, etc.) or if you want to manage the configuration yourself:
101+
43102
1. **Request API Key**
44-
Get your free API key: [https://mcp.pfx.ch/request-api-key.html](https://mcp.pfx.ch/request-api-key.html)
103+
[request-api-key.html](https://mcp.pfx.ch/request-api-key.html)
104+
105+
2. **Download Bridge Script**
106+
Download [mcp-http-bridge.txt](https://mcp.pfx.ch/bridge/mcp-http-bridge.txt) and rename to `mcp-http-bridge.js`
45107

46-
2. **Download MCP Bridge Script**
47-
Download: [mcp-http-bridge.js](https://mcp.pfx.ch/bridge/mcp-http-bridge.txt) (rename to `.js`)
108+
3. **Open Config File**
109+
Depending on client:
110+
- Claude: `%APPDATA%\Claude\claude_desktop_config.json` (Windows) or `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
111+
- Cursor/Windsurf: See [AI Client Setup](https://mcp.pfx.ch/ai-clients.html)
48112

49-
3. **Configure Claude Desktop**
50-
`%APPDATA%\Claude\claude_desktop_config.json` (Windows) or
51-
`~/Library/Application Support/Claude/claude_desktop_config.json` (macOS):
113+
4. **Add Server**
114+
See example config below:
52115

53116
```json
54117
{
@@ -69,8 +132,8 @@ Connect AI assistants (Claude, ChatGPT, Gemini) to your Proffix Px5 via standard
69132
}
70133
```
71134

72-
4. **Restart Claude Desktop**
73-
Ask Claude: *"Show me all addresses from Proffix"*
135+
5. **Restart Client and Test**
136+
Ask your AI assistant: *"Show me all addresses from Proffix"*
74137

75138
## 📚 Documentation
76139

@@ -91,10 +154,24 @@ Complete setup guides for all AI clients:
91154

92155
## 🔒 Security
93156

94-
- API Key for access control (free during beta)
95-
- Proffix credentials as HTTP headers (encrypted transmission)
96-
- No data storage on MCP server
97-
- Parameter-based auth without sessions
157+
### Authentication
158+
- **API Key** for access control (free during beta)
159+
- **Proffix Credentials** as HTTP headers (encrypted transmission)
160+
- **No Data Storage** on MCP server
161+
- **Parameter-based Auth** without sessions
162+
- Credentials are transmitted with each request and not stored
163+
164+
### Best Practices
165+
- Always use HTTPS for communication
166+
- Never store credentials in client code
167+
- Implement rate limiting on client side
168+
- Monitor API access regularly
169+
- Use strong passwords for Proffix API users
170+
171+
### Server Security
172+
- Comprehensive .htaccess security rules
173+
- Protection of sensitive files and configurations
174+
- HTTPS encryption recommended
98175

99176
## 🌐 Remote Server
100177

@@ -106,22 +183,43 @@ https://mcp.pfx.ch/api/server
106183
**Transport:** JSON-RPC 2.0 via HTTP
107184
**Status:** [https://mcp.pfx.ch/api/version](https://mcp.pfx.ch/api/version)
108185

109-
## 📋 Available Tools
186+
## 🔌 Model Context Protocol API
187+
188+
The pfx MCP Server implements the standardized Model Context Protocol via JSON-RPC 2.0:
189+
190+
### MCP Methods
191+
- **initialize** - Handshake between client and server. Exchanges capabilities and protocol version.
192+
- **tools/list** - Lists all available Proffix operations. Requires authentication.
193+
- **tools/call** - Executes a Proffix operation. Parameters are passed in `arguments`.
110194

195+
### Available Proffix Tools
111196
- `proffix_search_endpoints` - Fuzzy search across 120+ endpoints
112197
- `proffix_call_endpoint` - Direct endpoint call
113198
- `proffix_describe_endpoint` - Endpoint documentation
114199
- All specific Proffix API endpoints (Addresses, Articles, Orders, etc.)
115200

201+
**Server URL:** `https://mcp.pfx.ch/api/server`
202+
203+
[🔧 Test Examples & Debugging](https://mcp.pfx.ch/debug.html)
204+
116205
## 💡 Example Queries
117206

207+
### General Queries
118208
```
119209
"Show me all open invoices"
120210
"Search for articles with 'Laptop' in the name"
121211
"Which addresses changed this week?"
122212
"Create a report on sales by customer"
123213
```
124214

215+
### Department-Specific Examples
216+
- **Accounting:** "Show all unpaid invoices older than 30 days"
217+
- **Sales:** "List all quotes from Q4 2024 with status 'Open'"
218+
- **Purchasing:** "Which orders are overdue?"
219+
- **Controlling:** "Create a revenue overview by product groups"
220+
- **Support:** "Find all service cases for customer XY"
221+
- **Development:** "Document all available Proffix endpoints"
222+
125223
## 🔗 Links
126224

127225
- **Website:** [https://mcp.pfx.ch](https://mcp.pfx.ch)

0 commit comments

Comments
 (0)