Skip to content

refactor: pf-4402 add tool, resource provenance #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
cdcabrera wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

refactor: pf-4402 add tool, resource provenance #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/__tests__/__snapshots__/tool.patternFlyDocs.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,24 @@ exports[`usePatternFlyDocsTool should have a consistent return structure: struct
}
`;

exports[`usePatternFlyDocsTool, callback should attempt to parse parameters, multiple files, mock paths 1`] = `"# Content for components/button.md"`;
exports[`usePatternFlyDocsTool, callback should attempt to parse parameters, multiple files, mock paths 1`] = `"<!-- mcp:provenance id="components/button.md" -->"`;

exports[`usePatternFlyDocsTool, callback should attempt to parse parameters, single file, mock path 1`] = `"# Content for components/button.md"`;
exports[`usePatternFlyDocsTool, callback should attempt to parse parameters, single file, mock path 1`] = `"<!-- mcp:provenance id="components/button.md" -->"`;

exports[`usePatternFlyDocsTool, callback should attempt to parse parameters, with name and actual path 1`] = `"# Content for documentation:chatbot/README.md"`;
exports[`usePatternFlyDocsTool, callback should attempt to parse parameters, with name and actual path 1`] = `"<!-- mcp:provenance id="documentation:chatbot/README.md" -->"`;

exports[`usePatternFlyDocsTool, callback should have a specific markdown format: Button 1`] = `
[
{
"text": "# Documentation for Button (v6) [Documentation]
"text": "<!-- mcp:provenance id="components/loremButton.md" -->
# Documentation for Button (v6) [Documentation]
Source: components/loremButton.md

lorem documentation content

---

<!-- mcp:provenance id="components/ipsumButton.md" -->
# Content for components/ipsumButton.md
Source: components/ipsumButton.md

Expand Down
8 changes: 5 additions & 3 deletions src/resource.patternFlyDocsTemplate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ const resourceCallback = async (passedUri: URL, variables: Record<string, string
try {
const docPaths = byEntry
.filter(({ path }) => path)
.map(({ path, uriId }) => ({ doc: path, uri: uriId }));
.map(({ path, uriId, id, groupId, displayName, displayCategory, version: entryVersion }) =>
({ doc: path, uri: uriId, id, groupId, displayName, displayCategory, entryVersion }));

if (docPaths.length > 0) {
// `processDocsFunction` has de-dup docs baked in
Expand Down Expand Up @@ -172,11 +173,12 @@ const resourceCallback = async (passedUri: URL, variables: Record<string, string
}

return {
contents: docs.map(({ uri, path, resolvedPath, content }) => ({
contents: docs.map(({ uri, content, id, groupId, displayName, displayCategory, entryVersion }) => ({
uri,
mimeType: 'text/markdown',
text: stringJoin.newline(
`# Documentation from ${resolvedPath || path}`,
`<!-- mcp:provenance id="${id}" groupId="${groupId}" -->`,
`# Documentation for ${displayName} - ${displayCategory} (${entryVersion})`,
'',
content
)
Expand Down
5 changes: 5 additions & 0 deletions src/tool.patternFlyDocs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,15 +189,20 @@ const usePatternFlyDocsTool = (options = getOptions()): McpTool => {

for (const doc of docs) {
const patternFlyEntry = doc.path ? byPath[doc.path] : undefined;
const entryId = patternFlyEntry?.id;
const entryGroupId = patternFlyEntry?.groupId;
const entryName = patternFlyEntry?.name;
const entryVersion = patternFlyEntry?.version;
const entryVersionDisplay = (entryVersion && ` (${entryVersion})`) || '';

const provenance = entryId ? `<!-- mcp:provenance id="${entryId}" groupId="${entryGroupId}" -->` : `<!-- mcp:provenance id="${doc.path}" -->`;

const docTitle = patternFlyEntry
? `# Documentation for ${patternFlyEntry?.displayName || entryName}${entryVersionDisplay} [${setCategoryDisplayLabel(patternFlyEntry)}]`
: `# Content for ${doc.path}`;

docResults.push(stringJoin.newline(
provenance,
docTitle,
`Source: ${doc.path}`,
'',
Expand Down
4 changes: 3 additions & 1 deletion tests/e2e/__snapshots__/httpTransport.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ Use these parameters to filter the list of PatternFly component schemas.
`;

exports[`Builtin tools, HTTP transport should concatenate headers and separator with two remote files 1`] = `
"# Content for https://www.patternfly.org/notARealPath/AboutModal.md
"<!-- mcp:provenance id="https://www.patternfly.org/notARealPath/AboutModal.md" -->
# Content for https://www.patternfly.org/notARealPath/AboutModal.md
Source: https://www.patternfly.org/notARealPath/AboutModal.md

# Test Document
Expand All @@ -79,6 +80,7 @@ This is a test document for mocking remote HTTP requests.

---

<!-- mcp:provenance id="https://www.patternfly.org/notARealPath/ChartLegend.md" -->
# Content for https://www.patternfly.org/notARealPath/ChartLegend.md
Source: https://www.patternfly.org/notARealPath/ChartLegend.md

Expand Down
4 changes: 3 additions & 1 deletion tests/e2e/__snapshots__/stdioTransport.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ Use these parameters to filter the list of PatternFly component schemas.
`;

exports[`Builtin tools, STDIO should concatenate headers and separator with two remote files 1`] = `
"# Content for http://127.0.0.1:5010/notARealPath/AboutModal.md
"<!-- mcp:provenance id="http://127.0.0.1:5010/notARealPath/AboutModal.md" -->
# Content for http://127.0.0.1:5010/notARealPath/AboutModal.md
Source: http://127.0.0.1:5010/notARealPath/AboutModal.md

# Test Document
Expand All @@ -79,6 +80,7 @@ This is a test document for mocking remote HTTP requests.

---

<!-- mcp:provenance id="http://127.0.0.1:5010/notARealPath/README.md" -->
# Content for http://127.0.0.1:5010/notARealPath/README.md
Source: http://127.0.0.1:5010/notARealPath/README.md

Expand Down
Loading