krs-poland-mcp-server 1.0.5 → 1.0.7
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.
- package/README.md +20 -24
- package/build/index.mjs +13573 -3703
- package/package.json +4 -1
- package/build.mjs +0 -48
- package/logo.png +0 -0
- package/src/index.ts +0 -16
- package/src/server.ts +0 -27
- package/src/tools/currentExtract.ts +0 -53
- package/src/tools/fullExtract.ts +0 -52
- package/src/tools/index.ts +0 -7
- package/src/types/krs.ts +0 -25
- package/src/utils/api.ts +0 -31
- package/src/utils/format.ts +0 -13
- package/tsconfig.json +0 -15
package/README.md
CHANGED
|
@@ -1,40 +1,25 @@
|
|
|
1
1
|
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# KRS Poland MCP Server
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
An MCP server for the Polish National Court Register (KRS) public API.
|
|
6
6
|
|
|
7
7
|
## Usage
|
|
8
8
|
|
|
9
|
-
|
|
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
|
-
|
|
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
|
-
|
|
13
|
+
To start the server, run the following command:
|
|
24
14
|
|
|
25
15
|
```bash
|
|
26
|
-
|
|
16
|
+
npx krs-poland-mcp-server
|
|
27
17
|
```
|
|
28
18
|
|
|
29
|
-
|
|
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
|
-
|
|
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.
|