Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2026-01-08 03:28:51 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

🏷️ feat: Request Placeholders for Custom Endpoint & MCP Headers (#9095)

Browse source 
* feat: Add conversation ID support to custom endpoint headers

- Add LIBRECHAT_CONVERSATION_ID to customUserVars when provided
- Pass conversation ID to header resolution for dynamic headers
- Add comprehensive test coverage

Enables custom endpoints to access conversation context using {{LIBRECHAT_CONVERSATION_ID}} placeholder.

* fix: filter out unresolved placeholders from headers (thanks @MrunmayS)

* feat: add support for request body placeholders in custom endpoint headers

- Add {{LIBRECHAT_BODY_*}} placeholders for conversationId, parentMessageId, messageId
- Update tests to reflect new body placeholder functionality

* refactor resolveHeaders

* style: minor styling cleanup

* fix: type error in unit test

* feat: add body to other endpoints

* feat: add body for mcp tool calls

* chore: remove changes that unnecessarily increase scope after clarification of requirements

* refactor: move http.ts to packages/api and have RequestBody intersect with Express request body

* refactor: processMCPEnv now uses single object argument pattern

* refactor: update processMCPEnv to use 'options' parameter and align types across MCP connection classes

* feat: enhance MCP connection handling with dynamic request headers to pass request body fields

---------

Co-authored-by: Gopal Sharma <gopalsharma@gopal.sharma1>
Co-authored-by: s10gopal <36487439+s10gopal@users.noreply.github.com>
Co-authored-by: Dustin Healy <dustinhealy1@gmail.com>
This commit is contained in:
Danny Avila 2025-08-16 20:45:55 -04:00 • committed by GitHub
parent 627f0bffe5
commit d7d02766ea
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
25 changed files with 353 additions and 171 deletions
Download patch file Download diff file Expand all files Collapse all files

51
packages/api/src/utils/env.spec.ts
View file

@ -36,12 +36,14 @@ describe('resolveHeaders', () => {
});
it('should return empty object when headers is null', () => {
const result = resolveHeaders(null as unknown as Record<string, string> | undefined);
const result = resolveHeaders({
headers: null as unknown as Record<string, string>,
});
expect(result).toEqual({});
});
it('should return empty object when headers is empty', () => {
const result = resolveHeaders({});
const result = resolveHeaders({ headers: {} });
expect(result).toEqual({});
});
@ -52,7 +54,7 @@ describe('resolveHeaders', () => {
'Content-Type': 'application/json',
};
const result = resolveHeaders(headers);
const result = resolveHeaders({ headers });
expect(result).toEqual({
Authorization: 'test-api-key-value',
@ -68,7 +70,7 @@ describe('resolveHeaders', () => {
'Content-Type': 'application/json',
};
const result = resolveHeaders(headers, user);
const result = resolveHeaders({ headers, user });
expect(result).toEqual({
'User-Id': 'test-user-123',
@ -82,7 +84,7 @@ describe('resolveHeaders', () => {
'Content-Type': 'application/json',
};
const result = resolveHeaders(headers);
const result = resolveHeaders({ headers });
expect(result).toEqual({
'User-Id': '{{LIBRECHAT_USER_ID}}',
@ -97,7 +99,7 @@ describe('resolveHeaders', () => {
'Content-Type': 'application/json',
};
const result = resolveHeaders(headers, user);
const result = resolveHeaders({ headers, user });
expect(result).toEqual({
'User-Id': '{{LIBRECHAT_USER_ID}}',
@ -123,7 +125,7 @@ describe('resolveHeaders', () => {
'Content-Type': 'application/json',
};
const result = resolveHeaders(headers, user);
const result = resolveHeaders({ headers, user });
expect(result).toEqual({
'User-Email': 'test@example.com',
@ -148,7 +150,7 @@ describe('resolveHeaders', () => {
'Non-Existent': '{{LIBRECHAT_USER_NONEXISTENT}}',
};
const result = resolveHeaders(headers, user);
const result = resolveHeaders({ headers, user });
expect(result).toEqual({
'User-Email': 'test@example.com',
@ -171,7 +173,7 @@ describe('resolveHeaders', () => {
'X-User-Id': '{{LIBRECHAT_USER_ID}}',
};
const result = resolveHeaders(headers, user, customUserVars);
const result = resolveHeaders({ headers, user, customUserVars });
expect(result).toEqual({
Authorization: 'Bearer user-specific-token',
@ -194,7 +196,7 @@ describe('resolveHeaders', () => {
'Test-Email': '{{LIBRECHAT_USER_EMAIL}}',
};
const result = resolveHeaders(headers, user, customUserVars);
const result = resolveHeaders({ headers, user, customUserVars });
expect(result).toEqual({
'Test-Email': 'custom-email@example.com',
@ -213,7 +215,7 @@ describe('resolveHeaders', () => {
'User-Id': '{{LIBRECHAT_USER_ID}}',
};
const result = resolveHeaders(headers, user);
const result = resolveHeaders({ headers, user });
expect(result).toEqual({
'User-Role': 'admin',
@ -233,7 +235,7 @@ describe('resolveHeaders', () => {
'Backup-Email': '{{LIBRECHAT_USER_EMAIL}}',
};
const result = resolveHeaders(headers, user);
const result = resolveHeaders({ headers, user });
expect(result).toEqual({
'Primary-Email': 'test@example.com',
@ -259,7 +261,7 @@ describe('resolveHeaders', () => {
'Content-Type': 'application/json',
};
const result = resolveHeaders(headers, user, customUserVars);
const result = resolveHeaders({ headers, user, customUserVars });
expect(result).toEqual({
Authorization: 'Bearer secret-token',
@ -277,7 +279,7 @@ describe('resolveHeaders', () => {
};
const user = { id: 'user-123' };
const result = resolveHeaders(originalHeaders, user);
const result = resolveHeaders({ headers: originalHeaders, user });
// Verify the result is processed
expect(result).toEqual({
@ -306,7 +308,7 @@ describe('resolveHeaders', () => {
'Dot-Header': '{{CUSTOM.VAR}}',
};
const result = resolveHeaders(headers, user, customUserVars);
const result = resolveHeaders({ headers, user, customUserVars });
expect(result).toEqual({
'Dash-Header': 'dash-value',
@ -357,7 +359,7 @@ describe('resolveHeaders', () => {
'X-User-TermsAccepted': '{{LIBRECHAT_USER_TERMSACCEPTED}}',
};
const result = resolveHeaders(headers, user);
const result = resolveHeaders({ headers, user });
expect(result['X-User-ID']).toBe('abc');
expect(result['X-User-Name']).toBe('Test User');
@ -384,7 +386,7 @@ describe('resolveHeaders', () => {
'X-Multi': 'User: {{LIBRECHAT_USER_ID}}, Env: ${TEST_API_KEY}, Custom: {{MY_CUSTOM}}',
};
const customVars = { MY_CUSTOM: 'custom-value' };
const result = resolveHeaders(headers, user, customVars);
const result = resolveHeaders({ headers, user, customUserVars: customVars });
expect(result['X-Multi']).toBe('User: abc, Env: test-api-key-value, Custom: custom-value');
});
@ -394,7 +396,7 @@ describe('resolveHeaders', () => {
'X-Unknown': '{{SOMETHING_NOT_RECOGNIZED}}',
'X-Known': '{{LIBRECHAT_USER_ID}}',
};
const result = resolveHeaders(headers, user);
const result = resolveHeaders({ headers, user });
expect(result['X-Unknown']).toBe('{{SOMETHING_NOT_RECOGNIZED}}');
expect(result['X-Known']).toBe('abc');
});
@ -416,7 +418,7 @@ describe('resolveHeaders', () => {
'X-Boolean': '{{LIBRECHAT_USER_EMAILVERIFIED}}',
};
const customVars = { MY_CUSTOM: 'custom-value' };
const result = resolveHeaders(headers, user, customVars);
const result = resolveHeaders({ headers, user, customUserVars: customVars });
expect(result['X-User']).toBe('abc');
expect(result['X-Env']).toBe('test-api-key-value');
@ -426,4 +428,15 @@ describe('resolveHeaders', () => {
expect(result['X-Empty']).toBe('');
expect(result['X-Boolean']).toBe('true');
});
it('should process LIBRECHAT_BODY placeholders', () => {
const body = {
conversationId: 'conv-123',
parentMessageId: 'parent-456',
messageId: 'msg-789',
};
const headers = { 'X-Conversation': '{{LIBRECHAT_BODY_CONVERSATIONID}}' };
const result = resolveHeaders({ headers, body });
expect(result['X-Conversation']).toBe('conv-123');
});
});