krs-poland-mcp-server 1.0.4 → 1.0.6

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 (22) hide show
  1. package/README.md +20 -24
  2. package/build/index.mjs +14066 -0
  3. package/package.json +4 -2
  4. package/build/index.js +0 -15
  5. package/build/server.js +0 -17
  6. package/build/tools/currentExtract.js +0 -48
  7. package/build/tools/fullExtract.js +0 -47
  8. package/build/tools/index.js +0 -6
  9. package/build/types/krs.js +0 -1
  10. package/build/utils/api.js +0 -28
  11. package/build/utils/format.js +0 -9
  12. package/build.mjs +0 -34
  13. package/logo.png +0 -0
  14. package/src/index.ts +0 -16
  15. package/src/server.ts +0 -27
  16. package/src/tools/currentExtract.ts +0 -53
  17. package/src/tools/fullExtract.ts +0 -52
  18. package/src/tools/index.ts +0 -7
  19. package/src/types/krs.ts +0 -25
  20. package/src/utils/api.ts +0 -31
  21. package/src/utils/format.ts +0 -13
  22. package/tsconfig.json +0 -15
package/README.md CHANGED
@@ -1,40 +1,25 @@
1
1
  ![logo](logo.png)
2
2
 
3
- # krs-poland-mcp-server
3
+ # KRS Poland MCP Server
4
4
 
5
- The MCP server for KRS Poland public API.
5
+ An MCP server for the Polish National Court Register (KRS) public API.
6
6
 
7
7
  ## Usage
8
8
 
9
- You can also use `npx` to run the server without installing it globally:
9
+ This server is designed to be run with `npx`, allowing you to use it as a tool provider for LLM clients without a global installation.
10
10
 
11
- ```bash
12
- npx krs-poland-mcp-server
13
- ```
14
-
15
- ## Usage
16
-
17
- After installation, you can run the server with the following command:
18
-
19
- ```bash
20
- krs-poland-mcp-server
21
- ```
11
+ ### Running with `npx`
22
12
 
23
- Alternatively, you can run the server using `npm start`:
13
+ To start the server, run the following command:
24
14
 
25
15
  ```bash
26
- npm start
16
+ npx krs-poland-mcp-server
27
17
  ```
28
18
 
29
- ## Usage with LLM clients
30
-
31
- This MCP server can be used to provide tools to LLM clients. To serve the tools, run the following command:
19
+ ### Configuration for LLM Clients
32
20
 
33
- ```bash
34
- npx -y krs-poland-mcp-server
35
- ```
21
+ To integrate this server with an LLM client (like LM Studio or others that support MCP), you can configure it to spawn the server process. Here is an example configuration:
36
22
 
37
- and config:
38
23
  ```json
39
24
  {
40
25
  "mcpServers": {
@@ -49,10 +34,21 @@ and config:
49
34
  }
50
35
  ```
51
36
 
37
+ This configuration tells the client how to start the KRS tool server.
38
+
39
+ ## Development
40
+
41
+ To run the server in a development environment:
42
+
43
+ 1. Clone the repository.
44
+ 2. Install dependencies: `npm install`
45
+ 3. Build the project: `npm run build`
46
+ 4. Run the server: `npm start`
47
+
52
48
  ## Author
53
49
 
54
50
  Piotr Kolawa ([@pkolawa](https://github.com/pkolawa))
55
51
 
56
52
  ## License
57
53
 
58
- This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
54
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.