fa-mcp-sdk 0.2.247 → 0.2.249
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.
|
@@ -15,6 +15,66 @@ const dbEnabled = appConfig.isMainDBUsed;
|
|
|
15
15
|
const transport = appConfig.mcp.transportType; // 'stdio' | 'http'
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
+
### Service Identification
|
|
19
|
+
|
|
20
|
+
The SDK uses two primary identifiers for the service:
|
|
21
|
+
|
|
22
|
+
#### SERVICE_NAME → `appConfig.name`
|
|
23
|
+
|
|
24
|
+
**Formation:**
|
|
25
|
+
```
|
|
26
|
+
process.env.SERVICE_NAME || package.json.name
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
A derivative value `appConfig.shortName` is also created by removing "mcp" from the name:
|
|
30
|
+
```typescript
|
|
31
|
+
shortName = name.replace(/[\s\-]*\bmcp\b[\s\-]*/ig, '');
|
|
32
|
+
// Example: "my-mcp-service" → "my-service"
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
**Usage locations:**
|
|
36
|
+
|
|
37
|
+
| Component | Property | Purpose |
|
|
38
|
+
|--------------|-----------------------|-----------------------------------------|
|
|
39
|
+
| Consul | `consul.service.name` | Service registration in Consul |
|
|
40
|
+
| MCP Server | Server name | MCP protocol server identifier |
|
|
41
|
+
| Logger | File prefix | Log file naming (`<name>.log`) |
|
|
42
|
+
| JWT Auth | `expectedService` | Token validation - checks service claim |
|
|
43
|
+
| Admin API | `serviceName` | Service identification in API responses |
|
|
44
|
+
| MCP Resource | `project://id` | Returns service identifier |
|
|
45
|
+
| Cache | `keyPrefix` | Uses `shortName` for cache key prefixes |
|
|
46
|
+
| PM2 | Process name | `<name>[--<SERVICE_INSTANCE>]` |
|
|
47
|
+
|
|
48
|
+
#### PRODUCT_NAME → `appConfig.productName`
|
|
49
|
+
|
|
50
|
+
**Formation:**
|
|
51
|
+
```
|
|
52
|
+
process.env.PRODUCT_NAME || package.json.productName
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
This is the human-readable display name for the service.
|
|
56
|
+
|
|
57
|
+
**Usage locations:**
|
|
58
|
+
|
|
59
|
+
| Component | Purpose |
|
|
60
|
+
|-----------------|---------------------------------------|
|
|
61
|
+
| OpenAPI/Swagger | API title in documentation |
|
|
62
|
+
| Home page | Service title in web UI header |
|
|
63
|
+
| Server startup | Displayed in console startup message |
|
|
64
|
+
| MCP Resource | `project://name` returns product name |
|
|
65
|
+
|
|
66
|
+
#### Environment Variables
|
|
67
|
+
|
|
68
|
+
Set these in `.env` file to override `package.json` values:
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# Service identifier (technical name)
|
|
72
|
+
SERVICE_NAME=my-mcp-service
|
|
73
|
+
|
|
74
|
+
# Human-readable display name
|
|
75
|
+
PRODUCT_NAME=My MCP Service
|
|
76
|
+
```
|
|
77
|
+
|
|
18
78
|
### Configuration Files
|
|
19
79
|
|
|
20
80
|
**`config/default.yaml`** - Base configuration:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"home-api.d.ts","sourceRoot":"","sources":["../../../src/core/web/home-api.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
1
|
+
{"version":3,"file":"home-api.d.ts","sourceRoot":"","sources":["../../../src/core/web/home-api.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AA0B5C,wBAAsB,cAAc,CAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAsFjF"}
|
|
@@ -32,7 +32,9 @@ export async function handleHomeInfo(_req, res) {
|
|
|
32
32
|
const logoSvg = getLogoSvg();
|
|
33
33
|
const { resources } = getResourcesList();
|
|
34
34
|
const { prompts } = getPromptsList();
|
|
35
|
-
const {
|
|
35
|
+
const { httpComponents } = global.__MCP_PROJECT_DATA__;
|
|
36
|
+
const toolsOrFn = global.__MCP_PROJECT_DATA__.tools;
|
|
37
|
+
let tools = typeof toolsOrFn === 'function' ? await toolsOrFn() : toolsOrFn;
|
|
36
38
|
const { getConsulUIAddress = (_s) => '', assets } = getProjectData();
|
|
37
39
|
// Build footer HTML
|
|
38
40
|
const footerParts = [];
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"home-api.js","sourceRoot":"","sources":["../../../src/core/web/home-api.ts"],"names":[],"mappings":"AAAA;;;GAGG;
|
|
1
|
+
{"version":3,"file":"home-api.js","sourceRoot":"","sources":["../../../src/core/web/home-api.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE,MAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;AAE7B,MAAM,SAAS,GAAG,GAAW,EAAE;IAC7B,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,OAAO,EAAE,CAAC;IAClD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,aAAa,GAAG,EAAE,CAAC;IAEnC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,OAAO,GAAG,KAAK,KAAK,OAAO,KAAK,OAAO,GAAG,CAAC;IAC7C,CAAC;SAAM,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,GAAG,OAAO,KAAK,OAAO,GAAG,CAAC;IACnC,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,OAAO,GAAG,CAAC;IACvB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,cAAc,CAAE,IAAa,EAAE,GAAa;IAChE,IAAI,CAAC;QACH,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;QACpC,MAAM,YAAY,GAAG,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9F,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;QAC7B,MAAM,EAAE,SAAS,EAAE,GAAG,gBAAgB,EAAE,CAAC;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,cAAc,EAAE,CAAC;QACrC,MAAM,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC,oBAAoB,CAAC;QACvD,MAAM,SAAS,GAAG,MAAM,CAAC,oBAAoB,CAAC,KAAK,CAAC;QACpD,IAAI,KAAK,GAAW,OAAO,SAAS,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QACpF,MAAM,EAAE,kBAAkB,GAAG,CAAC,EAAU,EAAE,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,CAAC;QAE7E,oBAAoB;QACpB,MAAM,WAAW,GAAa,EAAE,CAAC;QACjC,IAAI,IAAI,EAAE,CAAC;YACT,WAAW,CAAC,IAAI,CAAC,YAAY,IAAI,wDAAwD,CAAC,CAAC;QAC7F,CAAC;QACD,IAAI,MAAM,EAAE,cAAc,EAAE,CAAC;YAC3B,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAC1C,CAAC;QAED,gBAAgB;QAChB,IAAI,EAAE,GAAG,IAAI,CAAC;QACd,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,MAAM,yBAAyB,EAAE,CAAC;YACnD,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,SAAS,CAAC,EAAE,CAAC,QAAS,CAAC,GAAG,CAAC,IAAK,CAAC;YAClE,EAAE,GAAG;gBACH,UAAU,EAAE,GAAG,IAAI,IAAI,IAAI,IAAI,QAAQ,EAAE;gBACzC,MAAM,EAAE,QAAQ;aACjB,CAAC;QACJ,CAAC;QAED,cAAc;QACd,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,IAAI,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,EAAE,EAAE,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;YACxC,IAAI,EAAE,EAAE,CAAC;gBACP,MAAM,GAAG;oBACP,EAAE;oBACF,GAAG,EAAE,kBAAkB,CAAC,EAAE,CAAC;iBAC5B,CAAC;YACJ,CAAC;QACH,CAAC;QAED,sDAAsD;QACtD,MAAM,UAAU,GAAG,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC;QAC7C,MAAM,eAAe,GAAG,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC;QACvD,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,GAAG,uBAAuB,EAAE,CAAC;QAE/D,MAAM,OAAO,GAAG,UAAU,EAAE,OAAO;YACjC,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC;YAChF,CAAC,CAAC,UAAU,CAAC;QAEf,MAAM,SAAS,GAAG,eAAe,EAAE,OAAO;YACxC,CAAC,CAAC,eAAe,CAAC,IAAI;YACtB,CAAC,CAAC,UAAU,CAAC;QAEf,MAAM,QAAQ,GAAG;YACf,YAAY;YACZ,WAAW,EAAE,SAAS,CAAC,WAAW;YAClC,OAAO;YACP,MAAM,EAAE,SAAS,EAAE;YACnB,YAAY,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO;YACvC,OAAO;YACP,UAAU,EAAE,KAAK,CAAC,MAAM;YACxB,cAAc,EAAE,SAAS,CAAC,MAAM;YAChC,YAAY,EAAE,OAAO,CAAC,MAAM;YAC5B,KAAK;YACL,SAAS;YACT,OAAO;YACP,EAAE;YACF,OAAO,EAAE,CAAC,CAAC,cAAc,EAAE,SAAS;YACpC,MAAM;YACN,OAAO;YACP,SAAS;YACT,IAAI;YACJ,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC;SAChC,CAAC;QAEF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrB,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC;YACnB,KAAK,EAAE,yBAAyB;YAChC,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fa-mcp-sdk",
|
|
3
3
|
"productName": "FA MCP SDK",
|
|
4
|
-
"version": "0.2.
|
|
4
|
+
"version": "0.2.249",
|
|
5
5
|
"description": "Core infrastructure and templates for building Model Context Protocol (MCP) servers with TypeScript",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"main": "dist/core/index.js",
|