bkper 3.5.0 → 3.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +74 -71
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
- [Bkper REST API]: https://bkper.com/docs/#rest-apis
1
+ [Bkper REST API]: https://bkper.com/docs/#rest-api-enabling
2
2
 
3
- A **command line** utility to create and update [Bkper Apps and Bots](https://bkper.com/docs/)
3
+ A **command line** utility to create and update [Bkper Apps and Bots](https://bkper.com/docs/) as well as to start the [MCP server](https://modelcontextprotocol.io) to support AI assistants and agents to interact with your Bkper books.
4
4
 
5
5
  ## Installation
6
6
 
@@ -32,9 +32,9 @@ yarn global add bkper
32
32
 
33
33
  - ```login``` - Logs the user in. Saves the client credentials to a ```~/.bkper-credentials.json``` file.
34
34
  - ```logout``` - Logs out the user by deleting client credentials.
35
+ - ```mcp start``` - Start the Bkper MCP (Model Context Protocol) server.
35
36
  - ```app -c``` - Create a new App based on ```./bkperapp.yaml``` file.
36
37
  - ```app -u``` - Update an existing App based on ```./bkperapp.yaml``` file.
37
- - ```mcp start``` - Start the Bkper MCP (Model Context Protocol) server.
38
38
 
39
39
  ### Examples
40
40
  ```
@@ -44,6 +44,77 @@ npm bkper login
44
44
  yarn bkper login
45
45
  ```
46
46
 
47
+ ### MCP (Model Context Protocol) Server
48
+
49
+ Bkper includes an MCP server that allows AI assistants and other tools to interact with your Bkper books through the [Model Context Protocol](https://modelcontextprotocol.io).
50
+
51
+ #### Starting the MCP Server
52
+
53
+ ```bash
54
+ bkper mcp start
55
+ ```
56
+
57
+ The server runs on stdio and provides the following tools:
58
+
59
+ - **list_books** - List all books accessible by the authenticated user
60
+ - **get_book** - Get details of a specific book by ID
61
+ - **get_balances** - Get account balances for a specific date or period
62
+ - **list_transactions** - List transactions with filtering options
63
+
64
+ #### Prerequisites
65
+
66
+ Before using the MCP server:
67
+ 1. Login using `bkper login` to set up authentication
68
+ 2. Enable the [Bkper REST API]
69
+ 3. Ensure the `BKPER_API_KEY` environment variable is set.
70
+
71
+ The MCP server uses the same authentication as the CLI, reading credentials from `~/.bkper-credentials.json`.
72
+
73
+ #### Integration Examples
74
+
75
+ ##### Claude Desktop
76
+
77
+ Add to your configuration file:
78
+ - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
79
+ - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
80
+
81
+ ```json
82
+ {
83
+ "mcpServers": {
84
+ "bkper": {
85
+ "command": "npx",
86
+ "args": ["bkper", "mcp", "start"],
87
+ "env": {
88
+ "BKPER_API_KEY": "your-api-key-here"
89
+ }
90
+ }
91
+ }
92
+ }
93
+ ```
94
+
95
+ ##### Other MCP Clients
96
+
97
+ For other MCP-compatible clients, configure them to run:
98
+ ```bash
99
+ BKPER_API_KEY=your-api-key npx bkper mcp start
100
+ ```
101
+
102
+ The server communicates via stdio, so any MCP client that supports stdio transport can connect to it.
103
+
104
+ #### Available MCP Tools
105
+
106
+ Once connected, the MCP client can:
107
+ - List your Bkper books
108
+ - Get account balances for any date or period
109
+ - Search and filter transactions
110
+ - Analyze your financial data
111
+
112
+ For more information about the Model Context Protocol, visit [modelcontextprotocol.io](https://modelcontextprotocol.io).
113
+
114
+
115
+
116
+ ## Apps and Bots
117
+
47
118
  ### Environment Variables
48
119
  The following environment variable is necessary in order to communicate with the [Bkper REST API]:
49
120
 
@@ -202,74 +273,6 @@ Bkper.setConfig({
202
273
  })
203
274
  ```
204
275
 
205
- ### MCP (Model Context Protocol) Server
206
-
207
- Bkper includes an MCP server that allows AI assistants and other tools to interact with your Bkper books through the [Model Context Protocol](https://modelcontextprotocol.io).
208
-
209
- #### Starting the MCP Server
210
-
211
- ```bash
212
- bkper mcp start
213
- ```
214
-
215
- The server runs on stdio and provides the following tools:
216
-
217
- - **list_books** - List all books accessible by the authenticated user
218
- - **get_book** - Get details of a specific book by ID
219
- - **get_balances** - Get account balances for a specific date or period
220
- - **list_transactions** - List transactions with filtering options
221
-
222
- #### Prerequisites
223
-
224
- Before using the MCP server:
225
- 1. Login using `bkper login` to set up authentication
226
- 2. Ensure the `BKPER_API_KEY` environment variable is set
227
-
228
- The MCP server uses the same authentication as the CLI, reading credentials from `~/.bkper-credentials.json`.
229
-
230
- #### Integration Examples
231
-
232
- ##### Claude Desktop
233
-
234
- Add to your configuration file:
235
- - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
236
- - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
237
-
238
- ```json
239
- {
240
- "mcpServers": {
241
- "bkper": {
242
- "command": "npx",
243
- "args": ["bkper", "mcp", "start"],
244
- "env": {
245
- "BKPER_API_KEY": "your-api-key-here"
246
- }
247
- }
248
- }
249
- }
250
- ```
251
-
252
- ##### Other MCP Clients
253
-
254
- For other MCP-compatible clients, configure them to run:
255
- ```bash
256
- BKPER_API_KEY=your-api-key npx bkper mcp start
257
- ```
258
-
259
- The server communicates via stdio, so any MCP client that supports stdio transport can connect to it.
260
-
261
- #### Available MCP Tools
262
-
263
- Once connected, the MCP client can:
264
- - List your Bkper books
265
- - Get account balances for any date or period
266
- - Search and filter transactions
267
- - Analyze your financial data
268
-
269
- For more information about the Model Context Protocol, visit [modelcontextprotocol.io](https://modelcontextprotocol.io).
270
-
271
-
272
-
273
276
  ## Documentation
274
277
 
275
278
  - [Developer Docs](https://bkper.com/docs)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bkper",
3
- "version": "3.5.0",
3
+ "version": "3.5.2",
4
4
  "description": "Node.js command line client for Bkper",
5
5
  "bin": {
6
6
  "bkper": "./lib/cli.js"