Skip to content

Add comprehensive MCP server instructions and reorganize guides#1

Merged
oscarvalenzuelab merged 1 commit intomainfrom
feature/enhance-mcp-server-instructions
Nov 7, 2025
Merged

Add comprehensive MCP server instructions and reorganize guides#1
oscarvalenzuelab merged 1 commit intomainfrom
feature/enhance-mcp-server-instructions

Conversation

@oscarvalenzuelab
Copy link
Copy Markdown
Contributor

Summary

This PR enhances the MCP server with comprehensive instructions for better integration and reorganizes documentation into a structured guides directory.

Changes

MCP Server Instructions Enhancement

  • Workflow Patterns: Documents the license-first approach and optimal tool execution order
  • Tool Selection Guidance: Provides clear guidance on when to use each tool for different compliance scenarios
  • Performance Constraints: Documents timeouts, depth limits, and package limits to avoid performance issues
  • Input Format Requirements: Includes examples for PURLs, CPEs, and SPDX identifiers
  • Common Workflows: Provides 5 ready-to-use workflow patterns for typical scenarios
  • Resource Access: Documents available resources (license database, policy templates)
  • Error Handling: Explains how tools signal failures and when to expect specific errors

Documentation Reorganization

  • Created new guides/ directory for specialized documentation
  • Moved MOBILE_APP_COMPLIANCE_GUIDE.md to guides/ folder
  • Updated all references in SUPPORT.md, CONTRIBUTING.md, and MANIFEST.in
  • Updated MANIFEST.in to recursively include all markdown files in guides directory

Documentation Updates

  • Added "Server Instructions" section to README.md explaining the new capabilities
  • Updated CHANGELOG.md with all new features and improvements

Benefits

  • Better context injection for MCP protocol integration
  • Clearer guidance on optimal tool usage patterns
  • Improved performance through documented constraints
  • More organized documentation structure
  • Easier to add future specialized guides

Testing

  • Verified all documentation links are functional
  • Confirmed no references to proprietary technologies in commit history
  • Validated MANIFEST.in includes guides directory properly

Related Documentation

- Add detailed server instructions for MCP protocol integration
  * Document workflow patterns (license-first approach, execution order)
  * Provide tool selection guidance for different scenarios
  * Document performance constraints and optimization tips
  * Include input format requirements and examples
  * Add common usage workflow patterns

- Reorganize documentation structure
  * Move MOBILE_APP_COMPLIANCE_GUIDE.md to guides/ directory
  * Update all references to moved guide
  * Update MANIFEST.in to recursively include guides

- Update CHANGELOG.md with new features

These enhancements improve MCP server context and help users
understand optimal tool selection and workflow patterns.
@oscarvalenzuelab oscarvalenzuelab merged commit da507ce into main Nov 7, 2025
2 checks passed
@oscarvalenzuelab oscarvalenzuelab deleted the feature/enhance-mcp-server-instructions branch November 7, 2025 07:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant